Skip to content

Commit

Permalink
feat: generate frictionless data package metadata (vega#631)
Browse files Browse the repository at this point in the history
* feat: generate `frictionless` data package metadata

Closes vega#629

- Adds `build_datapackage.py` script
- Generates initial metadata in both `.yaml` and `.json` formats

* feat(typing): spell mappings more explicitly

Improves readability, but mainly to support per-resource `description`, `sources`, `licenses`
See vega#631 (comment)

* refactor(ruff): misc linting

* ci: change default output to `json`, fix missing `contributors`

vega#631 (review), vega#631 (comment)

* feat: add support for `.arrow`

vega#631 (comment), vega#631 (comment)

* feat(DRAFT): add `.with_extras()`, for `description`, `source`, and `license`

Unused currently, depends on having a more structured `SOURCES.md`

vega#631 (comment)

* add data package to build step

* ci: add uv

* ci: fix uv setup

* ci: fail if there are changes

* just kidding (timestamps change things)

* chore: update pr template

---------

Co-authored-by: Dominik Moritz <[email protected]>
  • Loading branch information
2 people authored and dsmedia committed Dec 8, 2024
1 parent 20e8d82 commit f202231
Show file tree
Hide file tree
Showing 5 changed files with 3,044 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Please:
- [ ] Update the changelog in `README.md`. Add a new version if needed and add a short description of the change.
- [ ] Add information about new datasets to `sources.md`.
- [ ] Only add the `datapackage.json` if there are changes to it besides the timestamp.
4 changes: 4 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ jobs:
cache: 'npm'
node-version: 20

- uses: astral-sh/setup-uv@v3
with:
version: ">=0.5.0"

- name: Install Node dependencies
run: npm ci

Expand Down
Loading

0 comments on commit f202231

Please sign in to comment.