Insect Project

A Python application for generating and sending reports about insect observations and comments.

Prerequisites

• Python 3.12+
• Docker (optional, for containerized execution)

Local Setup

1. Clone the repository

2. Create a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies:

   pip install -r requirements.txt

4. Copy .env.template to .env and fill in your configuration:

   cp .env.template .env

Running Locally

Generate a comments report:

python run.py comments

Generate an observations report:

python run.py observations

Running with Docker

Build the image:

docker build -t insect-project .

Run the container:

# For observations report (default)
docker run --env-file .env insect-project

# For comments report
docker run --env-file .env insect-project comments

Environment Variables

Make sure to set up your environment variables in the .env file. See .env.template for required variables.