Project's Code Base

The code base of the project has following structure:

• .devcontainer/ - Developer's container configuration for VSCode Remote Containers. Just reopen project in remote container to get ready-to-development environment.

• .github/ - GitHub settings

  • workflows/ - GitHub Actions Workflows settings. Used to run tests and build the documentation.

• .requirements/ - Python dependencies for development environment.

  • docs.txt - Mkdocs Material dependencies.
  • ipython.txt - [IPython] dependencies.
  • lint.txt - Black, Ruff, and Mypy dependencies.
  • requirements.txt - Module's own dependencies.
  • test.txt - Pytest dependencies.

• docs/ - Mkdocs documentation.

• examples/ - Project's examples.
• src/ - Project's source code.
• tests/ - Project's Pytest test suite.
• .gitignore - Gitignore file.
• Dockerfile - Dockerfile for development container.
• mkdocs.yml - Mkdocs configuration file.
• pyproject.toml - pyproject.toml file for python tools configuration.
• setup.cfg - Python library setup configuration.