Cal-B/C

This tool calculates values based on Cal-B/C workbooks. It also provides automation around filling out workbooks.

This application requires uv to be installed. This can be installed using asdf:

$ asdf plugin add uv
$ asdf install

Install dependencies using uv:

$ uv sync

Copy .env.example to .env and fill in the secret values in the .env file:

$ cp .env.example .env

Set your Google Cloud project and login:

$ gcloud config set project cal-itp-data-infra-staging # you will want to unset this later with `gcloud config unset project`
$ gcloud auth application-default login --login-config=iac/login.json --quiet

Create the database and run migrations:

$ uv run manage.py sqlcreate | psql
$ uv run manage.py migrate

In another terminal tab, start the Tailwind build process:

$ uv run manage.py tailwind build
$ uv run manage.py tailwind watch

Then, collect all the static files and start the Django server:

$ uv run manage.py collectstatic
$ uv run manage.py runserver

Finally, start the Django tasks worker:

$ uv run manage.py db_worker

Now, visit the server at http://localhost:8000.

In order to run tests, you will need to ensure that Playwright is installed:

$ uv run playwright install

Now, run the tests:

$ uv run manage.py test

$ uv run manage.py test tests/cal_bc

This project uses ruff to lint code. To run linting and apply fixes:

$ uv run ruff check --fix

To run manage.py commands on the deployed Cloud Run instance, use the cal-bc-staging-manage Cloud Run Job.

For example, if you want to migrate the models app back to a specific migration, you would locally run:

$ uv run manage.py migrate models 0013_subsection_description

The Cloud Run Jobs equivalent using cal-bc-staging-manage is:

$ gcloud run jobs execute cal-bc-staging-manage --args migrate,models,0013_subsection_description --wait

In order to access the admin site at http://localhost:8000/admin, you need to create a superuser for your DOT login:

$ uv run manage.py createsuperuser
Username (leave blank to use 'yourname'): Your.Name@dot.ca.gov
Email address: Your.Name@dot.ca.gov
Password: ********
Password (again): ********

Now, when you visit the admin site, you can log in with your DOT account as usual.

To access or make changes to your local database, run:

$ uv run manage.py dbshell

To reset your local database, run:

$ uv run manage.py reset_db

This tool is licensed under the terms of the GNU Affero General Public License.