davewalker5/naturerecorderpy repository overview

⁠naturerecorderpy

The Nature Recorder is a personal widlife sightings logbook application implemented using Python.

The application provides facilities for recording and querying the following data:

• Locations, with the following details:
  • Unique name
  • Address details
  • Latitude and longitude
• Categories, with the following details:
  • Category name e.g. birds, mammals
• Species, with the following details:
  • The category to which the species belongs
  • Species name
• Species sightings, consisting of:
  • The species, and by implication the category the species belongs to
  • Location
  • Date
  • Gender of the animals seen
  • Number of animals seen (optional)
  • Whether or not they were seen with young
• Conservation status information, consisting of:
  • Conservation schemes, acting as containers for a set of rating values
  • Conservation status ratings, values for the conservation status within a scheme
  • Species conservation status ratings, status ratings for a species with effective start and end dates

The naturerecorderpy image contains a distribution of the application implementing a Flask-based web UI hosted on the Flask development server, for personal use only.

⁠Getting Started

⁠Prerequisities

In order to run this image you'll need docker installed.

• Windows⁠
• OS X⁠
• Linux⁠

⁠Usage

⁠Container Parameters

The following "docker run" parameters are recommended when running the naturerecorderpy image:

For example:

docker run -d -v /local:/var/opt/naturerecorderpy/ -p 80:5000 --rm davewalker5/naturerecorderpy:latest

The "/local" path given to the -v argument is described, below, and should be replaced with a value appropriate for the host running the container. Similarly, the port number "80" can be replaced with any available port on the host.

⁠Volumes

The description of the container parameters, above, specifies that a folder containing the SQLite database file for the application is mounted in the running container, using the "-v" parameter.

That folder should contain a SQLite database named "naturerecorder.db", created using the instructions in the project's README⁠

⁠Accessing the application the Image

To run the image, enter the following commands, substituting "/local" for the host folder containing the SQLite database, as described:

docker run -d -v /local:/var/opt/naturerecorderpy/ -p 80:5000 --rm davewalker5/naturerecorderpy:latest

Once the container is running, browse to the following URL on the host:

http://localhost:80⁠

You should see the sightings entry page, with other data maintenance and reporting options in the menu bar at the top of the page.

⁠Find Us

• NatureRecorderPy on GitHub⁠

⁠Versioning

For the versions available, see the tags on this repository⁠.

⁠Authors

• Dave Walker - Initial work - LinkedIn⁠

See also the list of contributors⁠ who participated in this project.

⁠License

This project is licensed under the MIT License - see the LICENSE⁠ file for details.