Nimbus Schemas

This directory contains a package of schemas published to various repositories for use by different parts of the Mozilla Nimbus experimentation ecosystem.

Installation/Usage

Prerequisites

  • python ^3.10
  • poetry ^1.8.4
  • node ^16
  • yarn ^1.22

Common Operations

From project root (i.e., parent to this directory)

  • Build: make schemas_build
  • Run linting and tests: make schemas_check
  • Code formatting: make schemas_format

Adding New Schemas

Example Creating a new sub-package new_stuff

  1. Add new directory mozilla_nimbus_schemas / new_stuff with schemas inside.

  2. Add new_stuff schemas to the new_stuff directory's __init__.py file.

  3. Add new_stuff to top level __init__.py:

    from mozilla_nimbus_schemas.new_stuff import *

  4. Generate Typescript and/or JSON Schemas for new_stuff by updating the generate_json_schema.py script like so:

    a. Import new_stuff alongside existing mozilla_nimbus_schemas imports, e.g.,

    from mozilla_nimbus_schemas import experiments, jetstream, new_stuff

    b. (optional) Add new_stuff to Typescript generation

    • Update TS_SCHEMA_PACKAGES list, e.g.,

      TS_SCHEMA_PACKAGES = [experiments, jetstream, new_stuff]

    c. (optional) Add new_stuff to JSON Schema generation

    • Update JSON_SCHEMA_PACKAGES list, e.g.,

      JSON_SCHEMA_PACKAGES = [experiments, new_stuff]

  5. Build everything with make schemas_build

  6. Update the version (see Versioning below).

Schemas

Jetstream

Contains schemas describing analysis results, metadata, and errors from Jetstream.

Experiments

Defines the schemas used for validating the Experimenter v6 API. Previously defined in the now-deprecated nimbus-shared.

Deployment

The build and deployment occurs automatically through CI. A deployment is triggered on merges into the main branch when the version number changes. Schemas are published to various repos for access in different languages.

Versioning

mozilla-nimbus-schemas uses semantic versioning (semver) of major.minor.patch. Previously, we used a date-based versioning scheme (CalVer), which is why the version is so high (3000+). Any breaking changes should result in an increase in the major version.

Version Updates

  1. To update the published package versions, update the VERSION file in this directory.
  • From the project root, you can run the helper script:
    • ./scripts/set_schemas_version.sh <version>
  • Or write to the file:
    • echo <version> > ./schemas/VERSION
  • Or simply edit the file in any text editor.
  1. Update the package versions with the new VERSION file:
  • make schemas_version

Python

Published to PyPI as mozilla-nimbus-schemas

Typescript

Published to NPM as @mozilla/nimbus-schemas

Rust

Not yet implemented.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

4 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for brennie from gravatar.com brennie Avatar for jeddai from gravatar.com jeddai Avatar for mikewilli from gravatar.com mikewilli
+1 more Avatar for project-nimbus-publishing from gravatar.com project-nimbus-publishing

Credits

Author: mikewilli

License

Other/Proprietary License (MPL 2.0)

Requires

Python <4.0, >=3.10

Classifiers

Report project as malware

Download files

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

Source Distribution

mozilla_nimbus_schemas-3004.0.0.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

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

mozilla_nimbus_schemas-3004.0.0-py3-none-any.whl (72.4 kB view details)

Uploaded Python 3

File details

Details for the file mozilla_nimbus_schemas-3004.0.0.tar.gz.

File metadata

File hashes

Hashes for mozilla_nimbus_schemas-3004.0.0.tar.gz
Algorithm Hash digest
SHA256 54f121bf756459caccffb16fa99e7f885680c2151d33cf86d666986f7f6c046e
MD5 54c602545bff186e45a6a4159a21190c
BLAKE2b-256 b7d30d883ba32f2cbd67fc1aca3645b76e93a412a3560bfe7a9dca507120e4b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for mozilla_nimbus_schemas-3004.0.0.tar.gz:

Publisher: deploy-schemas.yml on mozilla/experimenter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mozilla_nimbus_schemas-3004.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mozilla_nimbus_schemas-3004.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5abc1dac2536ae45ecc7b97c8b21bf7aec882fa97f80acf9d6a695a04e69d59d
MD5 166f901a80e61c6d0964c2ba1dcd1462
BLAKE2b-256 4d20668a461c82c687eee0500dddc2df98343fc3dc0f7a7e0939713e2833b8f1

See more details on using hashes here.

Provenance

The following attestation bundles were made for mozilla_nimbus_schemas-3004.0.0-py3-none-any.whl:

Publisher: deploy-schemas.yml on mozilla/experimenter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page