Atheneum Python

This project serves as a template for consistent, cross-platform, open-source Python package development.

One goal is to make it as simple as possible to go from cloning to a tested package with as few steps as possible. The general process should be as simple as:

poetry install
poetry run pytest

Directory structure

• root
  • .github
    • workflows
  • docs
  • examples
  • <package name>
  • test

Version control: Git

This setup relies on the projects being managed in a Git repository.

Dependency Management: Poetry

Error handling (TODO)

Consistent approach to handling error callbacks.

Testing: Pytest

Unit tests are created using pytest.

Formatting (TODO)

Code Coverage (TODO)

CI: GitHub Actions

Automatic testing, packaging, and deployment.

Documentation (TODO)

Licensing: BSD-3

Be sure to use your own copyright for your projects using this structure.