Stocksera Documentation

To run Stocksera using Docker, follow these steps:

1. Configure Database: Set your MYSQL credentials in config.yaml first. Note that for Docker containers, MYSQL_HOST might not be localhost (e.g., it might be db).
2. Run Docker Setup:

   py setup/docker.py

3. **Initialize Database**: If setting up for the first time, run the database setup script in a separate command prompt:
   ```bash
py setup/docker_db.py

Note: You may need to rerun setup/docker.py even if it shows errors, and you might need to rerun it after setup/docker_db.py completes successfully. Always ensure API keys are configured at http://localhost:8000/setup/.

Scheduled tasks can be executed using two different methods:

1. Web Interface: Navigate to http://localhost:8000/tasks and click the buttons corresponding to the tasks you wish to run.
2. Command Prompt: Run the Python scripts directly from the terminal.

Important Requirements:

• All commands must be executed from the main parent directory of the project.
• You must run scheduled_tasks/create_database.py before running any other scheduled tasks.
• Ensure all necessary API keys are configured in config.yaml or via the web interface at http://localhost:8000/tasks to prevent errors.

# Example: Running a task from the main parent directory
# Ensure you are in the project root (e.g., C:\Users\Desktop\Stocksera)
python scheduled_tasks/economy/get_inflation.py

To prevent errors during task execution, you must register for APIs from the following providers and add the credentials to either config.yaml or the web interface at http://localhost:8000/tasks:

You can install the Stocksera API directly via pip to use it in your Python projects.

pip install stocksera

Follow these steps to set up a local development environment for Stocksera:

1. Create and activate a virtual environment:

   py -m venv venv
   cd venv/Scripts
   activate
   cd ../..

2. **Install dependencies**:
   ```bash
pip install -r requirements.txt

3. Configure Database: You must set your MYSQL credentials in config.yaml before proceeding. Then run the local setup script:

   py setup/local.py

4. **Run the application**:
   ```bash
py manage.py runserver

CRITICAL: Ensure you have all necessary API keys configured at http://localhost:8000/setup/ to prevent errors during runtime.

When using the docker-compose.yml configuration, you can manage MySQL credentials and database names via environment variables in both the web and db services.

Note: Ensure that the credentials provided to the web service match those provided to the db service to allow the application to connect successfully.

environment:
  - MYSQL_ROOT_PASSWORD=admin
  - MYSQL_DATABASE=stocksera
  - MYSQL_PASSWORD=admin