Skip to main content

kinto-wizard is a tool to configure a kinto server from an YAML file.

Project description

kinto-wizard

pypi ci

kinto-wizard is a tool that lets you setup an entire Kinto server from a Yaml file, or inspect an existing server and output a Yaml file.

You can define Kinto objects (bucket, collection, groups, records) and configure their attributes and permissions.

Read more information about the file structure

Installation

Use pip:

$ pip install kinto-wizard

How to use it?

Load

kinto-wizard load \
    --server https://kinto-writer.stage.mozaws.net/v1 \
    --auth admin:credentials \
    new-config.yml

Dump

kinto-wizard dump \
    --server https://kinto-writer.stage.mozaws.net/v1 \
    --auth admin:credentials \
    > current-config.yml

The dump command also accepts these options:

  • --data - Include buckets, collections and groups data (attachments, schemas, display fields, uischema etc.).

  • --records - Include collections` records.

  • --full - Combination of data and records.

Validate a dump

The way Kinto works is by letting you change a collection schema but won’t enforce the new schema for existing records.

When you dump a collection and its records, you can end-up having records that Kinto won’t let you upload back because the schema changed and they are invalid with the current schema.

This can lead to unexpected behavior on loading time which is a bit cumbersome because depending of the size of the file you are loading, it can takes a long time before getting an actual error.

In order to fix the file before loading, you can use the validate command that would give you the error Kinto would return if you were to load the file on a Kinto server.

kinto-wizard validate current-config.yml

Development

See contributing docs

Contributors

Project details


Download files

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

Source Distribution

kinto_wizard-5.0.0.tar.gz (32.2 kB view details)

Uploaded Source

Built Distribution

kinto_wizard-5.0.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file kinto_wizard-5.0.0.tar.gz.

File metadata

  • Download URL: kinto_wizard-5.0.0.tar.gz
  • Upload date:
  • Size: 32.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kinto_wizard-5.0.0.tar.gz
Algorithm Hash digest
SHA256 5da1eb39f57a46fbd1d947b0b6969feeb8208653398e4ecd32fd40dfe5372152
MD5 255e43a761e2880bfbcdd16267dc5204
BLAKE2b-256 4c645d70aa4adb586c9306c45657db02ed5360113fbc1483d1fb38722cfa232e

See more details on using hashes here.

Provenance

The following attestation bundles were made for kinto_wizard-5.0.0.tar.gz:

Publisher: publish.yml on Kinto/kinto-wizard

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

File details

Details for the file kinto_wizard-5.0.0-py3-none-any.whl.

File metadata

  • Download URL: kinto_wizard-5.0.0-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kinto_wizard-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 78bf4d395bd46743669b345f699e80e6446ce0665f92bcb8206ff22d7c7dde29
MD5 fbee78dde3785bd86d9f5130b36c8b2e
BLAKE2b-256 cca836a0b7eb2a7e0f52ada985814c8fc48e84826e7b56f8feba9b01cc175181

See more details on using hashes here.

Provenance

The following attestation bundles were made for kinto_wizard-5.0.0-py3-none-any.whl:

Publisher: publish.yml on Kinto/kinto-wizard

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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page