wbia_whaleridgefindr - A plug-in for the finFindR gray whale ID algorithm
Project description
whaleridgefindr Plug-in - Part of the WildMe / Wildbook IA Project.
A plug-in for using the containerized version of the whaleridgefindr gray whale ID algorithm.
Running the whaleridgefindr Container
This plugin assumes that:
You have separately started the whaleridgefindr container with the command:
docker run -p 8004:8004/tcp --name flukebook_whaleridgefindr --network flukebook haimeh/whaleridgefindr:latest
Your WBIA container also has the same network (“flukebook” above) defined for it.
Development Setup
./run_developer_setup.sh
Code Style and Development Guidelines
Contributing
It’s recommended that you use pre-commit to ensure linting procedures are run on any commit you make. (See also pre-commit.com)
Reference pre-commit’s installation instructions for software installation on your OS/platform. After you have the software installed, run pre-commit install on the command line. Now every time you commit to this project’s code base the linter procedures will automatically run over the changed files. To run pre-commit on files preemtively from the command line use:
git add .
pre-commit run
# or
pre-commit run --all-files
Brunette
Our code base has been formatted by Brunette, which is a fork and more configurable version of Black (https://black.readthedocs.io/en/stable/).
Flake8
Try to conform to PEP8. You should set up your preferred editor to use flake8 as its Python linter, but pre-commit will ensure compliance before a git commit is completed.
To run flake8 from the command line use:
flake8
This will use the flake8 configuration within setup.cfg, which ignores several errors and stylistic considerations. See the setup.cfg file for a full and accurate listing of stylistic codes to ignore.
PyTest
Our code uses Google-style documentation tests (doctests) that uses pytest and xdoctest to enable full support. To run the tests from the command line use:
pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for wbia-whaleridgefindr-0.1.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e465c94df99438f755b84ad4e4d82cea2bbb23489e6faeb5311ddb031579e7a |
|
MD5 | aec294bb97e87060688b6ea282dd821c |
|
BLAKE2b-256 | 7af6701376c52eaea16e4f686d53b25e5d92c4a67d76380d414948d35e3011b6 |