InvenTree/docs/docs/develop/devcontainer.md

title

title
Devcontainer

Devcontainer

Devcontainers are the easiest way to get into InvenTree development. You can either run them on your machine in vscode or use github codespaces.

Setup in vscode

Prerequisites

You need to make sure that you have the following tools installed before continuing.

• git is needed to clone the repository
• docker is needed to run the devcontainer
• vscode is needed to edit and debug code

Setup/Installation

1. Clone the repository (If you want to submit changes fork it and use the url to your fork in the next step)

   git clone https://github.com/inventree/InvenTree.git
   

2. open vscode, navigate to the extensions sidebar and search for ms-vscode-remote.remote-containers. Click on install.
3. open the cloned folder from above by clicking on file > open folder
4. vscode should now ask you if you'd like to reopen this folder in a devcontainer. Click Reopen in Container. If it shouldn't ask you open the command palette (CMD+Shift+P) and search for Reopen in Container. This can take a few minutes until the image is downloaded, build and setup with all dependencies.

Setup in codespaces

Open inventree/InvenTree with your browser and click on Code, select the codespaces tab and click on create codespace on current branch. This may can take a few minutes until your inventree development environment is setup.

!!! warning "Close the terminal" The appearing terminal which says Welcome to codespaces is not using the virtual env. Close it and use a new terminal that will automatically connect to the venv for using commands.

Running tasks

Tasks can help you executing scripts. You can run them by open the command panel (CMD+Shift+P) and search for Run Task. Then choose the desired task.

Setup demo dataset

If you need some demo test-data, run the setup-test task. This will import an admin user with the password inventree. For more info on what this dataset contains see inventree/demo-dataset.

Setup a superuser

If you only need a superuser, run the superuser task. It should prompt you for credentials.

Running InvenTree

You can either only run InvenTree or use the integrated debugger for debugging. Goto the Run and debug side panel make sure InvenTree Server is selected. Click on the play button on the left.

!!! tip "Debug with 3rd party" Sometimes you need to debug also some 3rd party packages. Just select python: Django - 3rd party

You can now set breakpoints and vscode will automatically pause execution if that point is hit. You can see all variables available in that context and evaluate some code with the debugger console at the bottom. Use the play or step buttons to continue execution.

Plugin development

The easiest way for plugin developing is by using the InvenTree devcontainer. Just mount your plugin repository also into the devcontainer workspace and install it as pip editable package.

1. To mount your plugin repo into the workspace, add this to your .devcontainer/devcontainer.json file. (Make sure that you don't commit it)

   "mounts": [
     "source=/path/to/your/local/inventree-plugin,target=/workspaces/inventree-plugin,type=bind,consistency=cached"
   ],
   

2. Add /workspaces/inventree-plugin to your vscode workspace folders by click on File > Add folder to workspace….
3. Install your plugin as pip editable install by executing the following command in the venv.

   pip install -e /workspaces/inventree-plugin
   

4. Add InvenTree core code to Pylance IntelliSense path by adding the following file to your plugin repo .vscode/settings.json (Your path can be different depending on your setup):

   {
     "python.analysis.extraPaths": ["/workspaces/InvenTree/InvenTree"]
   }
   

Your plugin should now be activateable from the InvenTree settings. You can also use breakpoints for debugging.

Troubleshooting

Your ssh-keys are not available in the devcontainer but are loaded to the active ssh-agent on macOS

Make sure you enabled full disk access on macOS for vscode, otherwise your ssh-keys are not available inside the container (Ref: Automatically add SSH keys to ssh-agent [comment]).

You're not able to use your gpg-keys inside the devcontainer to sign commits on macOS

Make sure you have gnupg and pinentry-mac installed and set up correctly. Read this medium post for more info on how to set it up correctly.

Where are the database, media files, ... stored?

Backups, Commandhistory, media/static files, venv, plugin.txt, secret_key.txt, ... are stored in the dev folder. If you want to start with a clean setup, you can remove that folder, but be aware that this will delete everything you already setup in InvenTree.