Skip to content

Commit fdbd74c

Browse files
committed
final commits and addition of directory tree
1 parent 030c2d1 commit fdbd74c

File tree

5 files changed

+42
-4
lines changed

5 files changed

+42
-4
lines changed

.github/workflows/fetch.yml renamed to .github/workflows/fetch.yml.disabled

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
name: Fetch Data
22

33
on:
4-
# push:
54
schedule:
65
# 1:15am onwards, days 1-20, first month of each quarter
76
- cron: '15 1,5,9,13,17,21,23 1-20 1,4,7,10 *'

.github/workflows/process.yml renamed to .github/workflows/process.yml.disabled

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
name: Process Data
22

33
on:
4-
push:
54
schedule:
65
# 1:15am onwards, days 1-20, second month of each quarter
76
- cron: '15 1,5,9,13,17,21,23 1-20 2,5,8,11 *'

.github/workflows/report.yml renamed to .github/workflows/report.yml.disabled

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
name: Generate Report
22

33
on:
4-
# push:
54
schedule:
65
# 1:15am onwards, days 1-20, third month of each quarter
76
- cron: '15 1,5,9,13,17,21,23 1-20 3,6,9,12 *'

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,47 @@ See [`CONTRIBUTING.md`][org-contrib].
3838

3939
[org-contrib]: https://github.com/creativecommons/.github/blob/main/CONTRIBUTING.md
4040

41+
### Project Structure
42+
Please note that in the directory tree below, all instances of `fetch`, `process`, and `report` and referring to
43+
the three phases of data gathering, processing, and report generation.
44+
45+
```
46+
Quantifying/
47+
├── .github/
48+
│ ├── workflows/
49+
│ │ ├── fetch.yml
50+
│ │ ├── process.yml
51+
│ │ ├── report.yml
52+
│ │ └── static_analysis.yml
53+
├── data/ # Data storages from script runs
54+
│ ├── 20XXQX/
55+
│ │ ├── 1-fetch/
56+
│ │ ├── 2-process/
57+
│ │ ├── 3-report/
58+
│ │ │ └── README.md # All generated reports are displayed in the README
59+
│ └── ...
60+
├── dev/
61+
├── pre-automation/
62+
│ └── ... # All folders and files from the 2022 Data Discovery Program prior to automation
63+
├── scripts/ # Runs scripts for all phases
64+
│ ├── 1-fetch/
65+
│ ├── 2-process/
66+
│ ├── 3-report/
67+
│ └── shared.py
68+
├── .cc-metadata.yml
69+
├── .flake8
70+
├── .gitignore
71+
├── .pre-commit-config.yaml
72+
├── LICENSE
73+
├── Pipfile # Specifies the project's dependencies and Python version
74+
├── Pipfile.lock
75+
├── README.md
76+
├── env.example
77+
├── history.md
78+
├── pyproject.toml
79+
└── sources.md
80+
```
81+
4182

4283
## Development
4384

scripts/shared.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def log_paths(logger, paths):
6060
logger.info(f"PATHS:{paths_list}")
6161

6262

63-
def fetch_and_merge(repo_path, branch=None):
63+
def fetch_and_merge(repo_path, branch="main"):
6464
try:
6565
repo = Repo(repo_path)
6666
origin = repo.remote(name="origin")

0 commit comments

Comments
 (0)