Skip to main content

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 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nr_metadata-2.0.82.tar.gz (228.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nr_metadata-2.0.82-py2.py3-none-any.whl (299.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file nr_metadata-2.0.82.tar.gz.

File metadata

  • Download URL: nr_metadata-2.0.82.tar.gz
  • Upload date:
  • Size: 228.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nr_metadata-2.0.82.tar.gz
Algorithm Hash digest
SHA256 eda9568ddc30bff5e5bda1e69eca6a3b5b6a5007dffcd19bb66b934c65096395
MD5 dcb66a96664480414c607fc9eebaba05
BLAKE2b-256 d895a22d42e7bc40c7f2c9b6248c1a41c56f6d6c9646d473e15648270e9db0ba

See more details on using hashes here.

File details

Details for the file nr_metadata-2.0.82-py2.py3-none-any.whl.

File metadata

  • Download URL: nr_metadata-2.0.82-py2.py3-none-any.whl
  • Upload date:
  • Size: 299.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nr_metadata-2.0.82-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8a77648056500c9036c19cebc168d0204c24cb5181e511c932657c2d7d1a1ce5
MD5 b04a86cfc4199f2ab1b4971dd75ad5b6
BLAKE2b-256 7e1226ab3e83fe51d5483097021c83926a7eaf74a334c41df7d521ed68d1538a

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.0.82 This release

2 files

2.0.81

2 files

2.0.80

2 files

2.0.79

2 files

2.0.78

2 files

2.0.77

2 files

2.0.76

2 files

2.0.75

2 files

2.0.74

2 files

2.0.73

2 files

2.0.72

2 files

2.0.71

2 files

2.0.70

2 files

2.0.69

2 files

2.0.68

2 files

2.0.67

2 files

2.0.66

2 files

2.0.65

2 files

2.0.64

2 files

2.0.63

2 files

2.0.62

2 files

2.0.58

2 files

2.0.57

2 files

2.0.56

2 files

2.0.55

2 files

2.0.54

2 files

2.0.53

2 files

2.0.52

2 files

2.0.51

2 files

2.0.50

2 files

2.0.49

2 files

2.0.48

2 files

2.0.47

2 files

2.0.46

2 files

2.0.45

2 files

2.0.44

2 files

2.0.43

2 files

2.0.42

2 files

2.0.41

2 files

2.0.40

2 files

2.0.39

2 files

2.0.37

2 files

2.0.36

2 files

2.0.35

2 files

2.0.34

2 files

2.0.33

2 files

2.0.32

2 files

2.0.31

2 files

2.0.29

2 files

2.0.28

2 files

2.0.27

2 files

2.0.26

2 files

2.0.25

2 files

2.0.24

2 files

2.0.23

2 files

2.0.22

2 files

2.0.21

2 files

2.0.20

2 files

2.0.19

2 files

2.0.18

2 files

2.0.17

2 files

2.0.16

2 files

2.0.15

2 files

2.0.14

2 files

2.0.13

2 files

2.0.12

2 files

2.0.11

2 files

2.0.10

2 files

2.0.9

2 files

2.0.8

2 files

2.0.7

2 files

2.0.6

2 files

2.0.5

2 files

2.0.4

2 files

2.0.3

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.0.41

2 files

1.0.40

2 files

1.0.39

2 files

1.0.38

2 files

1.0.37

2 files

1.0.36

2 files

1.0.35

2 files

1.0.34

2 files

1.0.33

2 files

1.0.31

2 files

1.0.30

2 files

1.0.29

2 files

1.0.28

2 files

1.0.27

2 files

1.0.26

2 files

1.0.25

2 files

1.0.24

2 files

1.0.23

2 files

1.0.22

2 files

1.0.21

2 files

1.0.20

2 files

1.0.18

2 files

1.0.17

2 files

1.0.16

2 files

1.0.15

2 files

1.0.14

2 files

1.0.13

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page