Development Setup

I am a developer and I just need to know how to run the syncer

uv run usdb_syncer. Use tox to test.

For everybody else:

Installing tools

uv

Install uv if you haven't already. uv is used to manage the dependancies of the syncer.

Git

Install git if you haven't already. Git is used to synchronise work on different computers and provides a history of all changes.

Setting up usdb_syncer

Downloading and running

1. Clone the git repository to your machine: git clone https://github.com/bohning/usdb_syncer.git.
2. Enter the local git repository: cd usdb_syncer
3. Install dependencies with uv sync
4. Run usdb_syncer with uv run usdb_syncer

Testing

Use uv run tox in the project folder to test your changes.

Making changes to the UI.

Run the qt/pyside designer with poetry run pyside6-designer. Open and edit the .ui files at ~/src/usdb_syncer_gui/forms. Save in the designer, then re-run usdb_syncer. Do not edit the .py files in the forms directory. These are automatically generated and will be overwritten.

If you want to contribute, see the github docs