kinto-wizard
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.
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
The load command also accepts these options:
--data - Load data attributes.
--permissions: - Load objects permissions.
--collections - Load collections.
--groups - Load groups.
--records - Load collections` records.
--attachments - Load the attachments files from the specified folder
--full - Combination of all flags (default).
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.).
--permissions: - Include objects permissions.
--collections - Include collections.
--groups - Include groups.
--records - Include collections` records.
--attachments - Save the attachments files into the specified folder
--full - Combination of all flags (default).
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
Contributors
Rémy Hubscher <rhubscher@mozilla.com>
Mathieu Leplatre <mathieu@mozilla.com>
Gabriela Surita <gabsurita@gmail.com>
Release files for kinto-wizard 6.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| kinto_wizard-6.0.1.tar.gz | 35.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kinto_wizard-6.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 47.9 kB
Release files / kinto_wizard-6.0.1.tar.gz
| Download URL | kinto_wizard-6.0.1.tar.gz |
|---|---|
| Size | 35.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0735b953298b13205f7d779467f002ba56def205dd4427cd1bedb497e3f11849
|
|
BLAKE2b-256 checksum How to use checksums |
b1d485995db8cfe2a8ec119311fcb3624e0e91bef643a57755457807aef3f9ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 3, 2025.
Transparency logRelease files / kinto_wizard-6.0.1-py3-none-any.whl
| Download URL | kinto_wizard-6.0.1-py3-none-any.whl |
|---|---|
| Size | 12.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
36d999b521c1702f219443ecf8562f3d65b3437fa71ddebf0bfb25d2f35aed01
|
|
BLAKE2b-256 checksum How to use checksums |
79545f1f57d3dd68cd9d248e4bf081cdb88b2129c130bfeb2742ed7be271dbc7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 3, 2025.
Transparency log