Builds a set of CSVs and stores them into the collection data bucket under reporting. These CSVs are intended for reporting by the Collection and Management team. All data will be publicly accessible from files.planning.data.gov.uk/reporting.
src/- Python scripts that generate reporting datasetsdata/reporting/- Output directory for generated CSV filesMakefile- Build targets for each report (runmake allto generate all reports, ormake <target>for individual reports)requirements.txt- Python dependenciesrun.sh- Shell script for containerized executionDockerfile- Container configuration
Each Python script in src/ can be run individually with python src/script_name.py --output-dir <directory> (or python3 depending on your system setup). Note: if make all fails with "python: No such file or directory", your system requires python3 - edit the Makefile locally to replace python with python3.
To deploy a new reporting script:
- Create a pull request with your script and documentation
- Get code review approval from a team member
- Once merged, an infrastructure-deployer team member must approve the GitHub Actions workflow to deploy the changes
The software in this project is open source and covered by the LICENSE file.
Individual datasets copied into this repository may have specific copyright and licensing, otherwise all content and data in this repository is © Crown copyright and available under the terms of the Open Government 3.0 licence.