Skip to main content

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

Project description

brightest-path-lib

Python tests codecov OS License PyPI

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

brightest-path-lib-1.0.55.tar.gz (38.8 kB view hashes)

Uploaded Source

Built Distributions

brightest_path_lib-1.0.55-cp311-cp311-win_amd64.whl (51.2 kB view hashes)

Uploaded CPython 3.11 Windows x86-64

brightest_path_lib-1.0.55-cp311-cp311-manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (74.6 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.12+ x86-64 manylinux: glibc 2.17+ x86-64

brightest_path_lib-1.0.55-cp311-cp311-macosx_10_9_universal2.whl (34.2 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ universal2 (ARM64, x86-64)

brightest_path_lib-1.0.55-cp310-cp310-win_amd64.whl (51.2 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

brightest_path_lib-1.0.55-cp310-cp310-manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (74.6 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.12+ x86-64 manylinux: glibc 2.17+ x86-64

brightest_path_lib-1.0.55-cp310-cp310-macosx_12_0_x86_64.whl (55.9 kB view hashes)

Uploaded CPython 3.10 macOS 12.0+ x86-64

brightest_path_lib-1.0.55-cp39-cp39-win_amd64.whl (51.2 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

brightest_path_lib-1.0.55-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (74.6 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.12+ x86-64 manylinux: glibc 2.17+ x86-64

brightest_path_lib-1.0.55-cp39-cp39-macosx_12_0_x86_64.whl (45.2 kB view hashes)

Uploaded CPython 3.9 macOS 12.0+ x86-64

brightest_path_lib-1.0.55-cp38-cp38-win_amd64.whl (51.2 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

brightest_path_lib-1.0.55-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (74.7 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.12+ x86-64 manylinux: glibc 2.17+ x86-64

brightest_path_lib-1.0.55-cp38-cp38-macosx_12_0_x86_64.whl (45.2 kB view hashes)

Uploaded CPython 3.8 macOS 12.0+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page