brightest-path-lib 0.1.dev1

A library of path-finding algorithms to find the brightest path between points in an image.

brightest-path-lib

A Python package of path-finding algorithms to find the brightest path between points in an image.

Getting Started

To install and get started with the brightest-path-lib, please visit the documentation website.

For more detailed instructions on how to use the brightest-path-lib, please see the API documentation.

Contributing

Contributions are very welcome. Tests can be run with pytest, please ensure the coverage at least stays the same before you submit a pull request.

To contribute to this package, first checkout the code. Then create a new virtual environment:

cd brightest-path-lib
python -m venv brightest-venv
source brightest-venv/bin/activate

Now install the package with the testing dependencies:

pip install -e '.[test]'

To run the tests:

pytest

Issues

If you have any suggestions or encounter any problems, please file an issue along with a detailed description.

License

Distributed under the terms of the GNU GPL v3.0 license, "brightest-path-lib" is free and open source software.