Skip to content

Commit

Permalink
docs: add ci badge for tests, mention how to install on an unsupport …
Browse files Browse the repository at this point in the history
…python version, show how to run tests
  • Loading branch information
avivace committed Nov 18, 2024
1 parent 18f9ba1 commit 7cebb81
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<a href="https://pypi.org/project/pyBADA"><img alt="Released on PyPi" src="https://img.shields.io/pypi/v/pyBADA.svg"></a>
![Python 3.12](https://img.shields.io/badge/Python-3.12-3776AB.svg?logo=python&logoColor=white)
<a href="https://github.com/eurocontrol/pybada"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
[![Run unit tests](https://github.com/eurocontrol/pybada/actions/workflows/pytest.yml/badge.svg)](https://github.com/eurocontrol/pybada/actions/workflows/pytest.yml)

The BADA aircraft performance toolbox for Python

Expand All @@ -13,6 +14,7 @@ To get started
pip install pyBADA
```


## Examples

- `file_parser`: BADA file parser and retrieval of some basic BADA parameters for all BADA3/4/H
Expand All @@ -32,11 +34,19 @@ source env/bin/activate
pip install -e .
# Install a couple of packages for formatting, linting and building the docs
pip install -e .[dev]
# Run tests
python3 -m pytest tests/
# To build the docs
cd docs
make html
```


## Running on unsupported environements

You won't receive support for it, but you can pass the flag `--ignore-requires-python` to install pyBADA on an unsupported Python version.


## License

BADA and pyBADA are developed and maintained by [EUROCONTROL](https://www.eurocontrol.int/).
Expand Down

0 comments on commit 7cebb81

Please sign in to comment.