Merge remote-tracking branch 'inventree/master'

This commit is contained in:
Oliver Walters 2019-12-05 23:11:54 +11:00
commit f6d5f2e426
3 changed files with 23 additions and 2 deletions

4
.gitignore vendored
View File

@ -9,6 +9,10 @@ env/
./build/
develop-eggs/
dist/
bin/
lib64
pyvenv.cfg
share/
downloads/
eggs/
.eggs/

View File

@ -22,6 +22,23 @@ To install InvenTree you will need the following system components installed:
Each of these programs need to be installed (e.g. using apt or similar) before running the ``make install`` script.
Virtual Environment
-------------------
Installing the required Python packages inside a virtual environment allows a local install separate to the system-wide Python installation. While not strictly necessary, using a virtual environment is highly recommended as it prevents conflicts between the different Python installations.
To configure Inventree inside a virtual environment, ``cd`` into the inventree base directory and run the following commands:
``apt-get install python3-venv``
``source inventree/bin/activate``
This will place the current shell session inside a virtual environment - the terminal should display the ``(inventree)`` prefix.
.. note::
Remember to run ``source inventree/bin/activate`` when starting each shell session, before running Inventree commands. This will ensure that the correct environment is being used.
Installation
------------
@ -58,7 +75,7 @@ Once install settings are correctly configured (in *config.yaml*) run the initia
``make migrate``
which performs the initial database migrations, creating the required tables, etc
This performs the initial database migrations, creating the required tables, etc.
The database should now be installed!

View File

@ -6,5 +6,5 @@ ignore =
E501, E722,
# - C901 - function is too complex
C901,
exclude = .git,__pycache__,*/migrations/*
exclude = .git,__pycache__,*/migrations/*,*/lib/*,*/bin/*
max-complexity = 20