diff --git a/.gitignore b/.gitignore index 6b36e2d1d2..4c64eeae70 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,10 @@ env/ ./build/ develop-eggs/ dist/ +bin/ +lib64 +pyvenv.cfg +share/ downloads/ eggs/ .eggs/ diff --git a/docs/start.rst b/docs/start.rst index f45c3a8d14..65fbf7b1ec 100644 --- a/docs/start.rst +++ b/docs/start.rst @@ -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! diff --git a/setup.cfg b/setup.cfg index 61a1b69c6f..e56067f4ef 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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