kinto-wizard
============
|pypi| |ci|
.. |pypi| image:: https://img.shields.io/pypi/v/kinto-wizard.svg
:target: https://pypi.python.org/pypi/kinto-wizard
.. |ci| image:: https://img.shields.io/github/actions/workflow/status/Kinto/kinto-wizard/test.yml?branch=main
:target: https://github.com/Kinto/kinto-wizard/actions
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:
.. code-block:: bash
$ pip install kinto-wizard
How to use it?
--------------
Load
~~~~
.. code-block:: bash
kinto-wizard load \
--server https://kinto-writer.stage.mozaws.net/v1 \
--auth admin:credentials \
new-config.yml
The load command also accepts these options:
* ``--attachments`` - Load the attachments files from the specified folder
Dump
~~~~
.. code-block:: bash
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.
* ``--attachments`` - Save the attachments files into the specified folder
* ``--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.
.. code-block:: bash
kinto-wizard validate current-config.yml
Development
-----------
See `contributing docs <./.github/CONTRIBUTING.md>`_
Contributors
============
* Rémy Hubscher <rhubscher@mozilla.com>
* Mathieu Leplatre <mathieu@mozilla.com>
* Gabriela Surita <gabsurita@gmail.com>
Raw data
{
"_id": null,
"home_page": null,
"name": "kinto-wizard",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "web services",
"author": null,
"author_email": "Mozilla Services <developers@kinto-storage.org>",
"download_url": "https://files.pythonhosted.org/packages/25/51/29337edcc8f250a83633fa25c2b154fe4991ae3bd1dfce615a79511ff00d/kinto_wizard-5.1.0.tar.gz",
"platform": null,
"description": "kinto-wizard\n============\n\n|pypi| |ci|\n\n.. |pypi| image:: https://img.shields.io/pypi/v/kinto-wizard.svg\n :target: https://pypi.python.org/pypi/kinto-wizard\n.. |ci| image:: https://img.shields.io/github/actions/workflow/status/Kinto/kinto-wizard/test.yml?branch=main\n :target: https://github.com/Kinto/kinto-wizard/actions\n\nkinto-wizard is a tool that lets you setup an entire Kinto server from\na Yaml file, or inspect an existing server and output a Yaml file.\n\nYou can define Kinto objects (bucket, collection, groups, records)\nand configure their attributes and permissions.\n\nInstallation\n------------\n\nUse pip:\n\n.. code-block:: bash\n\n $ pip install kinto-wizard\n\n\nHow to use it?\n--------------\n\nLoad\n~~~~\n\n.. code-block:: bash\n\n kinto-wizard load \\\n --server https://kinto-writer.stage.mozaws.net/v1 \\\n --auth admin:credentials \\\n new-config.yml\n\nThe load command also accepts these options:\n\n* ``--attachments`` - Load the attachments files from the specified folder\n\nDump\n~~~~\n\n.. code-block:: bash\n\n kinto-wizard dump \\\n --server https://kinto-writer.stage.mozaws.net/v1 \\\n --auth admin:credentials \\\n > current-config.yml\n\nThe dump command also accepts these options:\n\n* ``--data`` - Include buckets, collections and groups data (attachments, schemas, display fields, uischema etc.).\n* ``--records`` - Include collections` records.\n* ``--attachments`` - Save the attachments files into the specified folder\n* ``--full`` - Combination of data and records.\n\nValidate a dump\n---------------\n\nThe way Kinto works is by letting you change a collection schema but\nwon't enforce the new schema for existing records.\n\nWhen you dump a collection and its records, you can end-up having\nrecords that Kinto won't let you upload back because the schema\nchanged and they are invalid with the current schema.\n\nThis can lead to unexpected behavior on loading time which is a bit\ncumbersome because depending of the size of the file you are loading,\nit can takes a long time before getting an actual error.\n\nIn order to fix the file before loading, you can use the validate\ncommand that would give you the error Kinto would return if you were\nto load the file on a Kinto server.\n\n\n.. code-block:: bash\n\n kinto-wizard validate current-config.yml\n\n\nDevelopment\n-----------\n\nSee `contributing docs <./.github/CONTRIBUTING.md>`_\n\nContributors\n============\n\n* R\u00e9my Hubscher <rhubscher@mozilla.com>\n* Mathieu Leplatre <mathieu@mozilla.com>\n* Gabriela Surita <gabsurita@gmail.com>\n",
"bugtrack_url": null,
"license": "Copyright 2012 - Mozilla Foundation\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n ",
"summary": "kinto-wizard is a tool to configure a kinto server from an YAML file.",
"version": "5.1.0",
"project_urls": {
"Repository": "https://github.com/Kinto/kinto-wizard"
},
"split_keywords": [
"web",
"services"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7753c24269c09d2063eee1b39185c7f26b6c2573c06d93b8ffaf3e6ed2685f2b",
"md5": "ee2f7e4e76f6ed0e3de15a4125ea417f",
"sha256": "4ad7e3b61b617fcbbbdc25cadaedb1ec9302972bcfc5b99d099873d81b50033c"
},
"downloads": -1,
"filename": "kinto_wizard-5.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee2f7e4e76f6ed0e3de15a4125ea417f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11152,
"upload_time": "2025-08-29T07:46:55",
"upload_time_iso_8601": "2025-08-29T07:46:55.555085Z",
"url": "https://files.pythonhosted.org/packages/77/53/c24269c09d2063eee1b39185c7f26b6c2573c06d93b8ffaf3e6ed2685f2b/kinto_wizard-5.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "255129337edcc8f250a83633fa25c2b154fe4991ae3bd1dfce615a79511ff00d",
"md5": "473ec37ea9b0e783a6fb81688d764554",
"sha256": "7186dd9262c6f1764067bc7bcfd53cce23bd5b5b20f88f451bb5899b56c6adde"
},
"downloads": -1,
"filename": "kinto_wizard-5.1.0.tar.gz",
"has_sig": false,
"md5_digest": "473ec37ea9b0e783a6fb81688d764554",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34357,
"upload_time": "2025-08-29T07:46:56",
"upload_time_iso_8601": "2025-08-29T07:46:56.677648Z",
"url": "https://files.pythonhosted.org/packages/25/51/29337edcc8f250a83633fa25c2b154fe4991ae3bd1dfce615a79511ff00d/kinto_wizard-5.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-29 07:46:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Kinto",
"github_project": "kinto-wizard",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "kinto-wizard"
}
JSON
