Scripts Index

This page provides an overview of all scripts used in The Wall API and their purposes.

1. Common Scripts

poetry_shell.sh

In Poetry 2.0+, the poetry shell command was removed. This script restores the convenience of activating the Poetry virtual environment directly in your current shell session, with a cross-platform command.

proxy_wall_creation.py

Encapsulates the core multiprocessing logic for wall construction simulation.
ℹ️ View script details.

2. Docker Scripts

docker-compose-dev+migrations.sh

Sets up containerized services, applies migrations, builds Docker images, and starts Celery, with Linux-specific steps for logs folder permissions.
ℹ️ View script details.

start_celery_computation_worker.py

Runs the Celery computation worker celery_worker_1.
ℹ️ View script details.

wait_for_celery_worker.py

During the Docker Compose process, ensures the Celery workers are fully initialized and ready by checking their status before starting the Celery Beat service.

wait_for_postgres.py

During the Docker Compose process, ensures the PostgreSQL service is fully initialized and ready before starting the Django app and running migrations.
Avoids introducing additional dependencies into the Dockerfile.

3. Linux Scripts

common_utils.sh

Shared utility functions for Linux scripts, including: resolving project root, managing environment files, and setting directory permissions.
To use: source this file in your scripts.

linux_install_prerequisites.sh

On Linux, sets up PostgreSQL, installs Poetry, and configures logs directory access.
ℹ️ View script details.

refresh_allowed_hosts_wsl2.sh

On Linux, updates ALLOWED_HOSTS with the current WSL2 IP and outputs the IP to the console.
ℹ️ View script details.

---

Return to Top
Installation Instructions Index
Home Page

---