Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
gargantext
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
humanities
gargantext
Commits
19195c95
Commit
19195c95
authored
Nov 02, 2017
by
sim
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[DOC] Installation guide
parent
e021fbda
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
70 additions
and
2 deletions
+70
-2
INSTALL.md
INSTALL.md
+70
-2
No files found.
INSTALL.md
View file @
19195c95
To bootstrap gargantext environment just do:
# Gargantext installation and dev environment
pipenv install
## TL;DR
You need
`pipenv`
and an up-to-date version of
`pip`
. To install and run:
$ pipenv install
$ pipenv run ./manage runserver
## Requirements
### Up-to-date pip
On Debian-like distros,
`pip`
is not installed by default, if you didn't do it
already:
$ sudo apt install python3-pip
Pipenv (see below) needs an up-to-date version of pip, on a Debian-like just
`apt upgrade`
, otherwise upgrade it like so:
$ pip install pip --user --upgrade
### Pipenv
You will need
[
pipenv
][
1
]
to easily get dependencies of Gargantext.
It handles packages and takes care of the virtualenv and environment variables.
There are various ways to install
`pipenv`
, see its
[
documentation
][
2
]
for more
insights. Here is the straightforward way:
$ pip install pipenv --user
[
1
]:
https://github.com/kennethreitz/pipenv
[
2
]:
https://docs.pipenv.org/
## Installation
To bootstrap Gargantext environment just cd into your local Gargantext repo and
do:
$ pipenv install
If everything is going well, you now have a clean virtualenv with every
packages you need to run Gargantext. Here is how to get the path of the
virtualenv directory pipenv just created:
$ pipenv --venv
You can now run any command by prefixing it with
`pipenv run`
or by first
entering the virtualenv with
`pipenv shell`
. To run Gargantext django backend
test server you can do:
$ pipenv run ./manage.py runserver
But also:
$ pipenv shell
$ ./manage.py runserver
$ ... continue in your virtualenv ...
## Customize dev environment
To install specific packages without messing with dependencies, just use pip.
For example, to install ipython or bpython shells locally:
$ pip install ipython
$ pip install bpython
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment