scoutbot 0.1.6

The computer vision for Wild Me's Scout project

Quick Links

• 1 How to Install

• 2 How to Run

• 3 Docker

• 4 Tests and Coverage

• 5 Building Documentation

• 6 Logging

• 7 Code Formatting

1 How to Install

(.venv) $ pip install scoutbot

or, from source:

git clone https://github.com/WildMeOrg/scoutbot
cd scoutbot
(.venv) $ pip install -e .

2 How to Run

You can run the tile-base Gradio demo with:

(.venv) $ python app.py

or, you can run the image-base Gradio demo with:

(.venv) $ python app2.py

3 Docker

The application can also be built into a Docker image and is hosted on Docker Hub as wildme/scoutbot:latest.

docker login

export DOCKER_BUILDKIT=1
export DOCKER_CLI_EXPERIMENTAL=enabled
docker buildx create --name multi-arch-builder --use

docker buildx build \
    -t wildme/scoutbot:latest \
    --platform linux/amd64 \
    --push \
    .

To run with Docker:

docker run \
   -it \
   --rm \
   -p 7860:7860 \
   --name scoutbot \
   wildme/scoutbot:latest

4 Tests and Coverage

You can run the automated tests in the tests/ folder by running:

(.venv) $ pip install -r requirements.optional.txt
(.venv) $ pytest

You may also get a coverage percentage by running:

(.venv) $ coverage html

and open the coverage/html/index.html file in your browser.

5 Building Documentation

There is Sphinx documentation in the docs/ folder, which can be built by running:

(.venv) $ cd docs/
(.venv) $ pip install -r requirements.optional.txt
(.venv) $ sphinx-build -M html . build/

6 Logging

The script uses Python’s built-in logging functionality called logging. All print functions are replaced with :func:log.info, which sends the output to two places:

• 1. the terminal window, and

• 2. the file scoutbot.log

7 Code Formatting

It’s recommended that you use pre-commit to ensure linting procedures are run on any code you write. See pre-commit.com for more information.

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:

(.venv) $ pip install -r requirements.optional.txt
(.venv) $ pre-commit run --all-files

The code base has been formatted by Brunette, which is a fork and more configurable version of Black. Furthermore, 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. 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.