Development

This section describes the process of developing the NQRduck software.

Style

Linting

Linting is done using ruff with the following configuration specified in the pyproject.toml file:

[tool.ruff]
exclude = [
  "widget.py",
  "base_spectrometer_widget.py",
]

[tool.ruff.lint]
extend-select = [
  "UP",  # pyupgrade
  "D",   # pydocstyle
]

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401"]

[tool.ruff.lint.pydocstyle]
convention = "google"

Run ruff check to lint the code, ideally in a pre-commit hook.

Formatting

Formatting is done using black.

Typing

Use type hints for all functions and classes. The type hints should be as specific as possible.

Documentation

Documentation is implemented with Sphinx project. The documentation is located in NQRduckumentation repository.

For docstrings in the code, the Google style is used.

Branching

The main branch is used for releases. Development is done on a development branch. Feature branches are created from the development branch and merged back into it. The development branch is merged into the main branch for releases. Releases are tagged with a version number starting with v (e.g. v0.1.0) and should follow semantic versioning (right now they don't).

Testing

Testing is done using pytest. The tests are located in the tests directory and can be run using pytest. Right now the tests are not very extensive, but they are a good starting point for further development.

Deployment

The software is deployed via PyPI. Different modules are distributed as separate packages. The Action is run on a tag push to the main branch starting with v (e.g. v0.1.0).
For Cython modules, aarch64 and x86_64 wheels are built using GitHub Actions. The wheels are deployed alongside the source distribution to PyPI.

2.1 KiB Raw Blame History