TEC PA & Lighting - PyRIGS

Welcome to TEC PA & Lighting's PyRIGS program. This is a reimplementation of the previous Rig Information Gathering System (RIGS) that was developed using Ruby on Rails. PyRIGS is our in house app for the centralisation of information on our events and now assets.

For setup information and other such helpful stuff check the Wiki

Apps

• PyRIGS: Base app, stores 'global' information
• RIGS: Rigboard stuff - event calendar etc
• assets: Database of our kit, testing data etc
• training: Logs in-house training within various "departments" (sound, lighting etc).
• versioning: Our custom logic built on top of django-reversion. Semi-modular.
• users: Our custom logic for registration and profiles. Semi-modular.

Running locally

Warning

compose.yml is for development only and must not be run in production. It mounts the source into the container, runs Django's development server with DEBUG on by default, and uses placeholder captcha keys. Production is deployed from the image built by the prod target of the Dockerfile.

The compose stack runs Postgres, the Django development server and a gulp watcher that rebuilds the CSS/JS. Changes to Python code and templates reload the app automatically, and changes to pipeline/source_assets are rebuilt into pipeline/built_assets (refresh the browser to pick them up).

1. Copy .env.example to .env and fill it in. For local use set at least:

   DEBUG=true
   DJANGO_ALLOWED_HOSTS=localhost
   

   The sample data commands refuse to run unless DEBUG (or STAGING) is true.
2. Start the stack (migrations run automatically on start):

   docker compose up -d --build
   

   The first start installs the node modules, so give the assets a minute to appear. After changing pyproject.toml, uv.lock or the Dockerfile, rebuild with docker compose up -d --build (or run docker compose watch).
3. Open http://localhost:8000/.

Creating a user

docker compose exec pyrigs python manage.py createsuperuser

Sample data

Load sample users, events, assets and training data (run once on a fresh database):

docker compose exec pyrigs python manage.py generateSampleData

The individual commands (generateSampleUserData, generateSampleRIGSData, generateSampleAssetsData, generateSampleTrainingData) can be run separately, but run the user one first. To remove the sample data again (requires DEBUG=true):

docker compose exec pyrigs python manage.py deleteSampleData

The sample data creates these logins (the password is the same as the username):

Username	Password	Access
superuser	superuser	Superuser
finance	finance	Finance and Keyholders groups
hs	hs	H&S and Keyholders groups
keyholder	keyholder	Keyholders group
basic	basic	Approved user, no groups

It also creates a number of generic profiles (e.g. AmyPond, RoryWilliams) which have no password set, so they can't be logged into.

Development

Linting and formatting use ruff, run through prek (a pre-commit compatible hook runner) using .pre-commit-config.yaml:

uv sync
uv run prek install        # run the hooks on every commit
uv run prek run --all-files