2017-03-23 01:44:10 +00:00
# InvenTree
Open Source Inventory Management System
2017-03-28 12:42:40 +00:00
2017-03-28 12:42:31 +00:00
[](https://travis-ci.org/inventree/InvenTree)
2017-03-23 23:55:24 +00:00
2017-03-29 00:58:34 +00:00
## Installation
2017-04-10 20:57:13 +00:00
It is recommended to set up a clean Python 3.4+ virtual environment first:
`mkdir ~/.env && python3 -m venv ~/.env/InvenTree && source ~/.env/InvenTree/bin/activate`
2017-03-29 00:58:34 +00:00
2017-04-10 20:57:13 +00:00
You can then continue running `make setup` (which will be replaced by a proper setup.py soon). This will do the following:
1. Installs required Python dependencies (requires [pip ](https://pypi.python.org/pypi/pip ), should be part of your virtual environment by default)
2017-03-29 00:58:34 +00:00
1. Performs initial database setup
1. Updates database tables for all InvenTree components
2017-04-10 20:57:13 +00:00
This command can also be used to update the installation if changes have been made to the database configuration.
2017-03-29 00:58:34 +00:00
2017-04-10 20:57:13 +00:00
To create an initial user account, run the command `make superuser` .
2017-03-29 00:58:34 +00:00
2017-03-23 23:55:24 +00:00
## Documentation
For project code documentation, refer to the online [documentation ](http://inventree.readthedocs.io/en/latest/ ) (auto-generated)
2017-04-01 02:19:37 +00:00
## Coding Style
2017-04-10 20:57:13 +00:00
If you'd like to contribute, install our development dependencies using `make develop` .
All Python code should conform to the [PEP 8 ](https://www.python.org/dev/peps/pep-0008/ ) style guide. Run `make style` which will compare all source (.py) files against the PEP 8 style. Tests can be run using `make test` .
