Skip to content

Commit

Permalink
Adding census_historical_migration README
Browse files Browse the repository at this point in the history
  • Loading branch information
Phil Dominguez committed Nov 3, 2023
1 parent 088eb0e commit 9027c63
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions backend/census_historical_migration/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Census Historical Migration

### How to run the historic data migrator:
```
docker compose run web python manage.py historic_data_migrator --email [email protected] \
--year 22 \
--dbkey 100010
```
- The email address currently must be a User in the system. As this has only been run locally so far, it would often be a test account in my local sandbox env.
- `year` and `dbkey` are optional. The script will use default values for these if they aren't provided.

### How to run the historic workbook generator:
```
docker compose run web python manage.py historic_workbook_generator
--year 22 \
--output <your_output_directory> \
--dbkey 100010
```
- `year` is optional and defaults to `22`.
- The `output` directory will be created if it doesn't already exist.

0 comments on commit 9027c63

Please sign in to comment.