oarepo-model-builder-nr


Nameoarepo-model-builder-nr JSON
Version 2.0.47 PyPI version JSON
download
home_pagehttps://github.com/Narodni-repozitar/oarepo-model-builder-nr
Summary"A model builder plugin with Czech National Repository compatible metadata schema"
upload_time2024-11-18 15:15:54
maintainerNone
docs_urlNone
authorMiroslav Simek
requires_python>=3.9
licenseMIT
keywords invenio czech nr model builder
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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/3a/a6/60abc90a93f82fc1df53f5c23ba398d5dbcff492487af44478a698599f88/oarepo_model_builder_nr-2.0.47.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.47",
    "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": "875d5f17cf9447fb1e9db94e2edd02cd6abcc59d8e34112bee29310a4d6d2983",
                "md5": "b19bfbddeed978b54e5dc483a9401e7c",
                "sha256": "930e41753c2eec65bf37f8eebfadd5390884a16bf3e07c9c32b2660d1dac1ad5"
            },
            "downloads": -1,
            "filename": "oarepo_model_builder_nr-2.0.47-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b19bfbddeed978b54e5dc483a9401e7c",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.9",
            "size": 20844,
            "upload_time": "2024-11-18T15:15:53",
            "upload_time_iso_8601": "2024-11-18T15:15:53.240708Z",
            "url": "https://files.pythonhosted.org/packages/87/5d/5f17cf9447fb1e9db94e2edd02cd6abcc59d8e34112bee29310a4d6d2983/oarepo_model_builder_nr-2.0.47-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3aa660abc90a93f82fc1df53f5c23ba398d5dbcff492487af44478a698599f88",
                "md5": "9795873ff130cb2371be0a7c9676436c",
                "sha256": "9f75a3935744e07acdb1ec1bde6c9fc9b9ee621160907be4c7e95cb1da1d3446"
            },
            "downloads": -1,
            "filename": "oarepo_model_builder_nr-2.0.47.tar.gz",
            "has_sig": false,
            "md5_digest": "9795873ff130cb2371be0a7c9676436c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 18088,
            "upload_time": "2024-11-18T15:15:54",
            "upload_time_iso_8601": "2024-11-18T15:15:54.337772Z",
            "url": "https://files.pythonhosted.org/packages/3a/a6/60abc90a93f82fc1df53f5c23ba398d5dbcff492487af44478a698599f88/oarepo_model_builder_nr-2.0.47.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-18 15:15: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"
}
        
Elapsed time: 1.41411s