2. Development - imxade/PictoPyV2 GitHub Wiki

Getting Started

1. Clone this repository.

2. Move inside the cloned repo.

Running the Application

PictoPy can be run in two main interfaces: Browser Interface and Native Interface.

A. Browser Interface

The Browser Interface allows you to run PictoPy as a web application accessible via a browser.

Option 1: Using Docker Compose

Requirements:

• Docker
• Docker Compose

Steps:

1. Build and start the containers:

   docker compose up
   

   This command will build the Docker image and start the container as specified in compose.yaml.

2. Access the application: Open your browser and go to http://127.0.0.1:5000.

Option 2: Using Python Virtual Environment

Requirements:

• Python 3.11 or higher
• Pip (Python package installer)

Steps:

1. Install Python dependencies:

   pip install -r requirements.txt
   

2. Run the application:

   python app.py
   

3. Access the application: Open your browser and go to http://127.0.0.1:5000.

B. Native Interface

The Native Interface allows you to run PictoPy as a standalone application.

Note: this is not suitable for non-native environments like Replit, GitHub Codespaces, or IDx.

Requirements:

• Python 3.11 or higher
• Pip (Python package installer)

Steps:

1. Install Python dependencies:

   pip install -r requirements.txt
   

2. Build the native application:

   python main.py
   

Configuration

• To alter app configuration simply modify config/config.py

Parameter	Description
homeDir	Directory to scan for media
dataDir	Directory containing app data
logPath	Path to log file
dbPath	Path to database
dbSchema	Schema for database
yoloModelPath	Model to use

Support

If you encounter any issues or have questions, please open an Issue or Discussion.

---