Develop

If you would like to participate in the development of this project or create your own fork, you can read this page to learn how to use uv to manage the development environment.

Download the code

The source code is mainly storaged at a self hosted Gitea server https://gitfub.cv .

Note

Repo is not in GitHub!

Clone the code to your local develop environment by the command:

git clone https://gitfub.cv/CleMooling/primitive-type.git

Or if SSH configured fine:

git clone git@gitfub.cv:CleMooling/primitive-type.git

Sync the uv environment

If you just want to do tests, use:

uv sync

Then, activate the virtual environment managed by uv:

source .venv/bin/<activate_script>

Note

If you are using bash , the script is named activate;

If you are using fish , the script is named activate.fish;

If you are using zsh , the script is named activate.zsh.

Now you can do any test you like.

If you want to run the tests built-in, execute:

python -m unittest discover tests

or:

uv run python -m unittest discover tests

if outside the uv environment.

If you want to actually participate in the development of this project or fork yourself and develop, you should run:

uv sync --all-groups

It will sync all needed python packages, including packages that are being used to build the docs.

Then you can edit anything.

Finally

Thanks for reading this documentation! I’ll keep updating it to ensure the correctness.