Skip to content

C language utils and tools based on the clang module.

License

Notifications You must be signed in to change notification settings

cuinixam/clanguru

Repository files navigation

clanguru

CI Status Documentation Status Test coverage percentage

Poetry ruff pre-commit

PyPI Version Supported Python versions License

C language utils and tools based on the clang module.

Installation

Install this via pip (or your favourite package manager):

pip install clanguru

Start developing

The project uses Poetry for dependencies management and packaging. Run the build.ps1 script to install Python and create the virtual environment.

.\build.ps1 -install

This will also generate a poetry.lock file, you should track this file in version control.

To execute the test suite, call pytest inside Poetry's virtual environment via poetry run:

.venv/Scripts/poetry run pytest

Check out the Poetry documentation for more information on the available commands.

For those using VS Code there are tasks defined for the most common commands:

  • bootstrap
  • install dependencies
  • run tests
  • run all checks configured for pre-commit
  • generate documentation

See the .vscode/tasks.json for more details.

Committing changes

This repository uses commitlint for checking if the commit message meets the conventional commit format.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Credits

This package was created with Copier and the cuinixam/pypackage-template project template.