Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-structuring, clean-up, fixes for first 0.2.x release #31

Merged
merged 27 commits into from
Feb 12, 2025
Merged
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
679db38
Remove make
dalito Feb 8, 2025
1ad8be5
Remove content in project that can be generated.
dalito Feb 8, 2025
99c2047
Adjust justfile & README for generating project dir contents
dalito Feb 8, 2025
25ac8ab
Make pypi & docs-preview optional via copier config
dalito Feb 9, 2025
29278ea
Remove create_python_classes template variable
dalito Feb 9, 2025
500af6c
Remove github_token_for_pypi_deployment template variable
dalito Feb 9, 2025
09056b6
Add yamllint config to template
dalito Feb 9, 2025
4ba4e83
Make example optional and always using Person class
dalito Feb 9, 2025
7a70ee2
Make docs handling more best-practice conform
dalito Feb 9, 2025
a81de7c
Change directory locations for docs
dalito Feb 9, 2025
d6c15f7
Manage docs in docs-directory the standard mkdocs-way
dalito Feb 10, 2025
16f1170
Add pydantic-generator
dalito Feb 10, 2025
e231abf
Fix slug-generation in copier questions
dalito Feb 10, 2025
0e5c3eb
Don't use just for docs build but only mkdocs
dalito Feb 10, 2025
e06ef9f
Directory rename docs/schema->docs/elements
dalito Feb 11, 2025
cfaf0cc
Fix comments in actions
dalito Feb 11, 2025
c2d9436
Reorganize example/test data locations
dalito Feb 11, 2025
d9e86ad
Add Unlicense as another license option
dalito Feb 11, 2025
e57c72d
Add __init__.py to package root
dalito Feb 11, 2025
653dd07
Improve just command help
dalito Feb 11, 2025
1cec890
Add .py.jinja to .editorconfig
dalito Feb 11, 2025
88fea25
Change to pytest & add test of invalid data
dalito Feb 11, 2025
3eb82d1
Remove example-dir handling from justfile
dalito Feb 11, 2025
70bb258
Improve example project & fix test data
dalito Feb 11, 2025
05c1e45
Prepare watch/rebuild schema docs; add root index.md
dalito Feb 11, 2025
c4e92c8
Add 0.2.0 migration to copier with just recipe
dalito Feb 12, 2025
93b009f
Update README after releasing v0.1.7
dalito Feb 12, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Reorganize example/test data locations
Related to #13
dalito committed Feb 11, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit c2d9436c1f13b5e7d3d849a62d5412692433ef4d
3 changes: 1 addition & 2 deletions copier.yaml
Original file line number Diff line number Diff line change
@@ -142,11 +142,10 @@ _skip_if_exists:
- LICENSE
- README.md
- project/*
- src/docs/files/about.md
- src/{{project_slug}}/data/*
- src/{{project_slug}}/datamodel/*
- src/{{project_slug}}/schema/*
- tests/test_data.py
- tests/data/*

_message_after_copy: |
7 changes: 4 additions & 3 deletions template/README.md.jinja
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@

## Repository Structure

* [examples/](examples/) - example data
* [examples/](examples/) - Examples of using the schema
* [project/](project/) - project files (these files are auto-generated, do not edit)
* [src/](src/) - source files (edit these)
* [{{project_slug}}](src/{{project_slug}})
@@ -19,14 +19,15 @@
* [datamodel](src/{{project_slug}}/datamodel) -- generated
Python datamodel
* [tests/](tests/) - Python tests
* [tests/data](tests/data) - Example data

## Developer Documentation

The pre-defined commands are written for the command runner [just](https://github.com/casey/just/).
Use the `just` commands to generate project artefacts:
* `just` or `just --list`: list all pre-defined tasks
* `just site`: (re-)create everything
* `just deploy`: deploys site
* `just site`: (re-)generate project artefacts & documentation
* `just deploy`: deploy documentation site to GitHub pages

## Credits

6 changes: 3 additions & 3 deletions template/examples/README.md.jinja
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Examples of use of {{project_slug}}
# Examples of using {{project_slug}}

This folder contains example data conforming to {{project_slug}}
This folder contains examples using the datamodel.

The source for these is in [src/data](../src/data/examples)
The source of the data used in the example is [tests/data](../tests/data/).
7 changes: 7 additions & 0 deletions template/tests/data/README.md.jinja
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Example data for {{project_slug}}

This folder contains example data for testing and demonstrating the datamodel` sorted in subfolders:

- `valid` for data conforming to the datamodel. Used to verify the datamodel.
- `invalid` for data not conforming to the datamodel. Used to verify the validation.
- `problem` for data which are not yet handled correctly in the current schema version, again separated into valid/invalid.
Empty file.
Empty file.
Empty file.
Empty file.