# 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](https://narodni-repozitar.github.io/developer-docs/docs/technology/invenio/nrp-toolchain/)
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 `version` file
- [ ] Run `build.sh` (note - this has to be run after modification to the `version` file)
- [ ] Create a merge request to the `aa.bb` branch
- [ ] Create a new github release.
## Updating model
To update the model version,
- [ ] start by creating a new branch with the name `aa.bb`, where `aa.bb` represents the new model version.
For example, if the current version is `2.0` and your changes are minor,
the new version should be `2.1`, while major changes warrant
a version bump to `3.0`.
- [ ] Set this branch as the default branch on GitHub.
- [ ] Rename files inside the `model` directory to include the correct version
- [ ] Change the model version inside the `build.sh` script
- [ ] Make your modifications to the files within the model directory
- [ ] Update the content of the `version` file to reflect the new version as
`aa.bb.0`
- [ ] Execute the `build.sh` script to ensure that everything builds correctly
- [ ] Push your changes to GitHub
- [ ] Mark the branch as the default branch
- [ ] Create a new GitHub release.
Raw data
{
"_id": null,
"home_page": "https://github.com/Narodni-repozitar/oarepo-model-builder-nr",
"name": "oarepo-model-builder-nr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "invenio Czech NR model builder",
"author": "Miroslav Simek",
"author_email": "simek.miroslav@techlib.cz",
"download_url": "https://files.pythonhosted.org/packages/39/5d/ae1a45fbb6f693be00075e93692c37a3562b25cc10ce846a86e6b1af6546/oarepo_model_builder_nr-2.0.22.tar.gz",
"platform": "any",
"description": "# NR model\n\nThis github project generates:\n\n* `nr-metadata` - runtime support containing marshmallow, serializers, ... for NR metadata (documents and data)\n* `oarepo-model-builder-nr` - a plugin for oarepo-model-builder to generate \n\n## Incompatible changes\n\nNone yet. If you introduce any incompatible changes (vs previous major version),\nenumerate them here and link the readme file from the previous major version\nfor reference.\n\n## Usage\n\nSee the `examples/model.yaml` file for a skeleton of a repository \nwhich uses nr metadata document model. An even easier way is to use the\n[nrp](https://narodni-repozitar.github.io/developer-docs/docs/technology/invenio/nrp-toolchain/) \ncommand to generate a documents- or data- compatible repository. \nSee the same pages to get help about the model contents.\n\n## Branches\n\nBranches are always named \"aa.bb\" and denote the version of the contained metadata schema.\n\n## Updating package\n\nPackage needs to be updated whenever the version of oarepo-model-builder and \nother builder plugins changes and influences the generated files.\n\nThe package version is always in the form of `aa.bb.ccc`, where `aa.bb` is the version\nof the metadata schema and `ccc` is the version of the python package.\n\nTo rebuild python packages:\n\n- [ ] Create a development branch (named after the issue inside linear or github issue)\n- [ ] Implement your changes\n- [ ] Increase the version number in `version` file\n- [ ] Run `build.sh` (note - this has to be run after modification to the `version` file)\n- [ ] Create a merge request to the `aa.bb` branch\n- [ ] Create a new github release.\n\n## Updating model\n\nTo update the model version, \n- [ ] start by creating a new branch with the name `aa.bb`, where `aa.bb` represents the new model version. \n\n For example, if the current version is `2.0` and your changes are minor, \n the new version should be `2.1`, while major changes warrant \n a version bump to `3.0`.\n\n- [ ] Set this branch as the default branch on GitHub. \n\n- [ ] Rename files inside the `model` directory to include the correct version\n- [ ] Change the model version inside the `build.sh` script\n\n- [ ] Make your modifications to the files within the model directory \n- [ ] Update the content of the `version` file to reflect the new version as \n`aa.bb.0`\n- [ ] Execute the `build.sh` script to ensure that everything builds correctly \n- [ ] Push your changes to GitHub\n- [ ] Mark the branch as the default branch\n- [ ] Create a new GitHub release.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "\"A model builder plugin with Czech National Repository compatible metadata schema\"",
"version": "2.0.22",
"project_urls": {
"Homepage": "https://github.com/Narodni-repozitar/oarepo-model-builder-nr"
},
"split_keywords": [
"invenio",
"czech",
"nr",
"model",
"builder"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d9fa256a135301c75df79f9eceefd6e9d52e7490cc56065815b9733200ec5339",
"md5": "fdb1700607b616fc3234129636643bce",
"sha256": "ca42f9146d6aad6b8db9bdcc29a753779017dc4c68310484447bbf4f342bb427"
},
"downloads": -1,
"filename": "oarepo_model_builder_nr-2.0.22-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "fdb1700607b616fc3234129636643bce",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 17444,
"upload_time": "2024-04-29T13:31:52",
"upload_time_iso_8601": "2024-04-29T13:31:52.831758Z",
"url": "https://files.pythonhosted.org/packages/d9/fa/256a135301c75df79f9eceefd6e9d52e7490cc56065815b9733200ec5339/oarepo_model_builder_nr-2.0.22-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "395dae1a45fbb6f693be00075e93692c37a3562b25cc10ce846a86e6b1af6546",
"md5": "e4164bc9b58145f470ead49db1afc32f",
"sha256": "46cc8dbba7427a7284ace2cccd95192fe83466a41c42ea116ffab7a1e92b18a7"
},
"downloads": -1,
"filename": "oarepo_model_builder_nr-2.0.22.tar.gz",
"has_sig": false,
"md5_digest": "e4164bc9b58145f470ead49db1afc32f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14832,
"upload_time": "2024-04-29T13:31:54",
"upload_time_iso_8601": "2024-04-29T13:31:54.082117Z",
"url": "https://files.pythonhosted.org/packages/39/5d/ae1a45fbb6f693be00075e93692c37a3562b25cc10ce846a86e6b1af6546/oarepo_model_builder_nr-2.0.22.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 13:31:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Narodni-repozitar",
"github_project": "oarepo-model-builder-nr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "oarepo-model-builder-nr"
}
JSON
