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|

.. |pypi| image:: https://img.shields.io/pypi/v/kinto-wizard.svg
:target: https://pypi.python.org/pypi/kinto-wizard
.. |ci| image:: https://travis-ci.org/Kinto/kinto-wizard.svg?branch=master
:target: https://travis-ci.org/Kinto/kinto-wizard
.. |coverage| image:: https://coveralls.io/repos/github/Kinto/kinto-wizard/badge.svg?branch=master
:target: https://coveralls.io/github/Kinto/kinto-wizard?branch=master

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 <https://github.com/Kinto/kinto/wiki/Handling-permission-on-a-Kinto-Server>`_


Installation
------------

The last release
~~~~~~~~~~~~~~~~

.. code-block:: bash

pip install kinto-wizard


The development version
~~~~~~~~~~~~~~~~~~~~~~~

After having cloned the repo:

.. code-block:: bash

pip install -e .


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

Dump
~~~~

.. code-block:: bash

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

The dump also accepts a ``--full`` option that will output object data and collection
records.


1Changelog
=========

This document describes changes between each past release.

2.4.0 (2018-05-23)
------------------

- Add a ``--dry-run`` for the load command to see how many records
would be deleted. (#46)
- Add a ``--delete-record`` to delete the existing records that are
not in the YAML file. (#47)


2.3.0 (2017-10-04)
------------------

- Add ``--data`` and ``--records`` options to be able to dump objects
data without dumping records. (#33)


2.2.0 (2017-09-01)
------------------

**New features**

- Use ``asyncio`` to add parallelism to the ``load`` command (#18).


2.1.0 (2017-06-28)
------------------

**New features**

- Add logger configuration for kinto-http.py (#26)
- Add an option to force the update with a CLIENT_WINS strategy (#28)
- Add an option to select the bucket or collection to export (#30)


2.0.0 (2017-05-22)
------------------

**Breaking changes**

- Upgrade to kinto-http 8.0.0 with Python 3.5+ support.
- The ``--full`` option of the ``dump`` command now outputs records (#16)

**New features**

- The ``load`` command now supports records (#16)


1.0.0 (2016-11-22)
------------------

**Initial version**

- Supports dumping/loading groups and permissions from/to a YAML file.


Contributors
============

* Rémy Hubscher <rhubscher@mozilla.com>
* Mathieu Leplatre <mathieu@mozilla.com>
* Gabriela Surita <gabsurita@gmail.com>

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-2.4.0.tar.gz (10.6 kB view hashes)

Uploaded source

Built Distribution

kinto_wizard-2.4.0-py2.py3-none-any.whl (12.6 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page