NR model
This github project generates:
nr-metadata- runtime support containing marshmallow, serializers, ... for NR metadata (documents and data)oarepo-model-builder-nr- a plugin for oarepo-model-builder to generate
Incompatible changes
None yet. If you introduce any incompatible changes (vs previous major version), enumerate them here and link the readme file from the previous major version for reference.
Usage
See the examples/model.yaml file for a skeleton of a repository
which uses nr metadata document model. An even easier way is to use the
nrp
command to generate a documents- or data- compatible repository.
See the same pages to get help about the model contents.
Branches
Branches are always named "aa.bb" and denote the version of the contained metadata schema.
Updating package
Package needs to be updated whenever the version of oarepo-model-builder and other builder plugins changes and influences the generated files.
The package version is always in the form of aa.bb.ccc, where aa.bb is the version
of the metadata schema and ccc is the version of the python package.
To rebuild python packages:
- Create a development branch (named after the issue inside linear or github issue)
- Implement your changes
- Increase the version number in
versionfile - Run
build.sh(note - this has to be run after modification to theversionfile) - Create a merge request to the
aa.bbbranch - Create a new github release.
Updating model
To update the model version,
-
start by creating a new branch with the name
aa.bb, whereaa.bbrepresents the new model version.For example, if the current version is
2.0and your changes are minor, the new version should be2.1, while major changes warrant a version bump to3.0. -
Set this branch as the default branch on GitHub.
-
Rename files inside the
modeldirectory to include the correct version -
Change the model version inside the
build.shscript -
Make your modifications to the files within the model directory
-
Update the content of the
versionfile to reflect the new version asaa.bb.0 -
Execute the
build.shscript to ensure that everything builds correctly -
Push your changes to GitHub
-
Mark the branch as the default branch
-
Create a new GitHub release.
1 maintainer
Metadata
1 maintainer
Release files for oarepo-model-builder-nr 2.0.82
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| oarepo_model_builder_nr-2.0.82.tar.gz | 18.4 kB | Without provenance | Details for oarepo_model_builder_nr-2.0.82.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| oarepo_model_builder_nr-2.0.82-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for oarepo_model_builder_nr-2.0.82-py2.py3-none-any.whl |
Total release size: 39.7 kB
Release files / oarepo_model_builder_nr-2.0.82.tar.gz
| Download URL | oarepo_model_builder_nr-2.0.82.tar.gz |
|---|---|
| Size | 18.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
407060f70f39f2599c515a74b34a452fad7725ffc02e15ae1bb859503ec563dc
|
|
BLAKE2b-256 checksum How to use checksums |
2fa2bb60dec2f0d1a5c5d84ab2cf3920345cfc2d23cf1099df47cc04f0ff35b8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / oarepo_model_builder_nr-2.0.82-py2.py3-none-any.whl
| Download URL | oarepo_model_builder_nr-2.0.82-py2.py3-none-any.whl |
|---|---|
| Size | 21.4 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
6f873381b02129fe02a742402a4d935f405e2d0128edf3ac29fb7ca93a6c7581
|
|
BLAKE2b-256 checksum How to use checksums |
163fed84b5bb95ae464f44e0c1332a51dad4822c77c6600f64086fb46a94fba8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for oarepo-model-builder-nr 2.0.82
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
