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

oarepo_model_builder_nr-2.0.82.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

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

oarepo_model_builder_nr-2.0.82-py2.py3-none-any.whl (21.4 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for oarepo_model_builder_nr-2.0.82.tar.gz
Algorithm Hash digest
SHA256 407060f70f39f2599c515a74b34a452fad7725ffc02e15ae1bb859503ec563dc
MD5 f6627fa3fc8b37e484cc4d062ded572c
BLAKE2b-256 2fa2bb60dec2f0d1a5c5d84ab2cf3920345cfc2d23cf1099df47cc04f0ff35b8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for oarepo_model_builder_nr-2.0.82-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6f873381b02129fe02a742402a4d935f405e2d0128edf3ac29fb7ca93a6c7581
MD5 c406c973966e60f6cdf92f6b6f4d711d
BLAKE2b-256 163fed84b5bb95ae464f44e0c1332a51dad4822c77c6600f64086fb46a94fba8

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

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