Skip to content

Commit 8c30599

Browse files
authored
Add repository structure to README
1 parent b72a117 commit 8c30599

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,20 @@
22

33
[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/digital-land/digital-land-builder/blob/master/LICENSE)
44

5-
builds a set of csvs and stores them into the collection data bucket under reporting. These csvs intended purpose are to be used for reporting by the Collecting and management team. All data will be publicly accessible `from files.planning.data.gov.uk/reporting`
5+
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`.
66

7-
# Licence
7+
## Repository Structure
8+
9+
- **`src/`** - Python scripts that generate reporting datasets
10+
- **`data/reporting/`** - Output directory for generated CSV files
11+
- **`Makefile`** - Build targets for each report (run `make all` to generate all reports, or `make <target>` for individual reports)
12+
- **`requirements.txt`** - Python dependencies
13+
- **`run.sh`** - Shell script for containerized execution
14+
- **`Dockerfile`** - Container configuration
15+
16+
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`.
17+
18+
## Licence
819

920
The software in this project is open source and covered by the [LICENSE](LICENSE) file.
1021

0 commit comments

Comments
 (0)