Skip to content

Build reporting reated datasets for ingestion elsewhere

License

Notifications You must be signed in to change notification settings

digital-land/reporting-task

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Reporting Datasets

License

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.

Repository Structure

  • src/ - Python scripts that generate reporting datasets
  • data/reporting/ - Output directory for generated CSV files
  • Makefile - Build targets for each report (run make all to generate all reports, or make <target> for individual reports)
  • requirements.txt - Python dependencies
  • run.sh - Shell script for containerized execution
  • Dockerfile - 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.

Deploying New Scripts

To deploy a new reporting script:

  1. Create a pull request with your script and documentation
  2. Get code review approval from a team member
  3. Once merged, an infrastructure-deployer team member must approve the GitHub Actions workflow to deploy the changes

Licence

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.

About

Build reporting reated datasets for ingestion elsewhere

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages