🌟 About the Project

InvenTree is an open-source Inventory Management System which provides powerful low-level stock control and part tracking. The core of the InvenTree system is a Python/Django database backend which provides an admin interface (web-based) and a REST API for interaction with external interfaces and applications. A powerful plugin system provides support for custom applications and extensions.

Check out our website for more details.

🧭 Roadmap

Want to see what we are working on? Check out the roadmap tag and horizon milestone.

🛠️ Integration

InvenTree is designed to be extensible, and provides multiple options for integration with external applications or addition of custom plugins:

• InvenTree API
• Python module
• Plugin interface
• Third party tools

👾 Tech Stack

🧰 Deployment / Getting Started

There are several options to deploy InvenTree.

Single line install - read the docs for supported distros and details about the function:

wget -qO install.sh https://get.inventree.org && bash install.sh

Refer to the getting started guide for a full set of installation and setup instructions.

🧪 Testing

InvenTree includes a comprehensive test suite to ensure code quality and reliability. Here are the different ways to run tests:

Running Tests with Invoke

The project uses invoke tasks for running tests. Make sure you have the development dependencies installed:

# Install development dependencies
pip install -r src/backend/requirements-dev.txt

# Run all tests
invoke test

# Run tests with coverage analysis
invoke test --coverage

# Keep the test database (useful for debugging)
invoke test --keepdb

# Show slow test report
invoke test --report

Running Specific Tests

You can run specific tests using the --runtest parameter:

# Run tests from a specific app
invoke test --runtest=company

# Run tests from a specific test file
invoke test --runtest=company.test_api

# Run tests from a specific test class
invoke test --runtest=company.test_api.TestCompanyAPI

# Run a specific test method
invoke test --runtest=company.test_api.TestCompanyAPI.test_create_company

Running Tests with Django

You can also run Django tests directly:

cd src/backend/InvenTree

# Run all tests
python manage.py test

# Run tests from a specific app
python manage.py test company

# Run tests from a specific test file
python manage.py test company.test_api

# Run tests from a specific test class
python manage.py test company.test_api.TestCompanyAPI

# Run a specific test method
python manage.py test company.test_api.TestCompanyAPI.test_create_company

Test Organization

Tests are organized by app in the src/backend/InvenTree/ directory:

• company/test_api.py - Company-related API tests
• part/test_api.py - Part-related API tests
• stock/test_api.py - Stock-related API tests
• users/test_api.py - User-related API tests
• And many more...

Additional Test Options

# Include migration tests
invoke test --migrations

# Run Django check before tests
invoke test --check

# Compile translations before tests
invoke test --translations

# Run tests with specific tags
python manage.py test --tag=api
python manage.py test --tag=slow

Setting Up Test Environment

To set up a testing environment with sample data:

# Setup test environment with demo dataset
invoke setup_test

# Setup test environment and install development dependencies
invoke setup_test --dev

For more detailed testing information, refer to the development documentation.

📱 Mobile App

InvenTree is supported by a companion mobile app which allows users access to stock control information and functionality.

🔒 Code of Conduct & Security Policy

The InvenTree project team is committed to providing a safe and welcoming environment for all users. Please read our Code of Conduct for more information.

InvenTree is following industry best practices for security. Our security policy is included in this repo. We provide dedicated security pages on our documentation site.

👋 Contributing

Contributions are welcomed and encouraged. Please help to make this project even better! Refer to the contribution page.

📜 Translation

Native language translation of the InvenTree web application is community contributed via crowdin. Contributions are welcomed and encouraged.

💸 Sponsor

If you use InvenTree and find it to be useful, please consider sponsoring the project.

💎 Acknowledgements

We want to acknowledge PartKeepr as a valuable predecessor and inspiration. Find a full list of used third-party libraries in the license information dialog of your instance.

❤️ Support

This project is supported by the following sponsors:

With ongoing resources provided by:

⚠️ License

Distributed under the MIT License. See LICENSE.txt for more information.