usdb_syncer is written in Python. The following explains how to set up a development environment. A Python installation with version 3.10 or later is assumed.
tox makes it easy to run the full CI pipeline on your local machine, i.e., if the pipeline passes on your machine there is a good chance it will also pass on the build server. The minimal setup to develop your package is to create a virtual environment and install the package and its runtime requirements:
# Your Python installation may instead be available under `py` or `python`.
python3 -m venv venv
# In Windows PowerShell run this instead: `.\venv\Scripts\Activate.ps1`
# In Windows CMD run this instead: `.\venv\scripts\activate.bat`
source venv/bin/activate
pip install --upgrade pip tox
pip install -e '.[dev]'The package has a defined entry point for the GUI. Simply type in usdb_syncer in your terminal. Make sure that your venv is activated.
Run tox to execute the test pipeline. The tox pipelines are configured in the tox.ini file. Configurations for specific tools in the pipeline are maintained in the pyproject.toml file. Tox is configured to create its own virtual environments, install test dependencies and the package you are developing, and run all tests. If you changed the test requirements or want to perform a clean run for some reason, you can run tox -r to recreate tox's virtual environment.
The following tools are part of the test pipeline:
-
isort: Automatically sorts your imports.
-
black: Automatically and deterministically formats your code.
-
mypy: Statically checks your type hints.
-
pylint: Statically checks your code for errors and code smells.
-
pytest: Provides a framework for unit tests.
If you don’t want to run the whole test pipeline, you can also use single commands from the pipeline, e.g., pytest. The tools will automatically pick up the correct configuration from the pyproject.toml file.
