Skip to main content

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

Project description

kinto-wizard

pypi ci coverage

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-4.0.3.tar.gz (32.7 kB view details)

Uploaded Source

Built Distribution

kinto_wizard-4.0.3-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file kinto-wizard-4.0.3.tar.gz.

File metadata

  • Download URL: kinto-wizard-4.0.3.tar.gz
  • Upload date:
  • Size: 32.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for kinto-wizard-4.0.3.tar.gz
Algorithm Hash digest
SHA256 c54d5db38c0797ec264db86bb0bd1ec7819ead42712c04fc5c948b3badf98b79
MD5 7d59e1dee4c21243ab623dae0218c9fa
BLAKE2b-256 9569f163d61666bde794df382c2379d56de6997ffc0450f263c7ac5e2d2cb01b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for kinto_wizard-4.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 31ba0b64d67f38dcf9cf46462868bb9cdd510f8827acae58185bc45e7f13fb79
MD5 5d9c60ae49e7f147188e55634eb56c2f
BLAKE2b-256 e3e3542420be9e3b88f15e4af2fe05479a7a02d1eed117a591c91ec3c456d424

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page