A Python package for estimating the efficiency of commercial aircraft.
Maintenance Team: @michaelweinold
See the package documentation for installation instructions.
The package documentation is based on mkdocs. To build the documentation locally, install the required packages from the docs/_requirements.txt file and navigate to the package root directory to execute:
mkdocs servePackage tests are based on pytest. To run all tests, navigate to the package root directory, install the testing dependencies, and execute:
pip install -e .[testing]
pytestWhen developing with Visual Studio Code, tests can also be run from the Test Explorer sidebar.
The package uses GitHub Actions for continuous integration and deployment. The CI/CD pipeline is defined in the .github/workflows directory.
| Workflow | Description | Trigger |
|---|---|---|
.github/workflows/test_package.yml |
Runs the test suite across supported Python versions. | Pull requests to main and dev, pushes to main and dev, and manual triggers. |
.github/workflows/publish_testpypi.yml |
Runs tests, builds distributions, and uploads the package to TestPyPI. | Every new Git tag and manual triggers. |
.github/workflows/publish_pypi.yml |
Runs tests, builds distributions, and uploads the package to PyPI. | Every new GitHub release. |
.github/workflows/update_license.yml |
Updates the copyright year(s) in the license file. | Scheduled annually on January 1. |