pysicgl

pysicgl

pysicgl is a Python C extension interface for the sicgl graphics library.

both projects are young and would benefit from community involvement.

getting started as a developer

get submodules

git submodule update --init --recursive

set up the python environment

• remove any existing virtual environment
• create a new virtual environment
• activate the virtual environment
• install development dependencies

rm -rf venv
python3 -m venv venv # use your Python 3 interpreter
source venv/bin/activate
pip install -r requirements.dev.txt

build and develop pysicl

python setup.py build
python setup.py develop

run tests and install

python -m pytest
python setup.py test
python setup.py install

build and upload to pypi

Note: this is how you can do it manually, but it is automated by github actions.

git checkout <tag>
python setup.py sdist
twine upload dist/*

twine upload dist/* --repository-url https://test.pypi.org/legacy/

# username: __token__
# password: <token>
twine upload --repository testpypi dist/* # do a test upload
twine upload dist/* # do a real upload

formatting

source venv/bin/activate
./scripts/third-party/run-clang-format/run-clang-format.py -r include src
black .

design choices

color sequences

color sequences are immutable. side effects are not allowed.