Metadata-Version: 1.1
Name: kinto-wizard
Version: 4.0.1
Summary: kinto-wizard is a tool to configure a kinto server from an YAML file.
Home-page: https://github.com/Kinto/kinto-wizard
Author: Mozilla Services
Author-email: storage-team@mozilla.com
License: Apache License (2.0)
Description-Content-Type: UNKNOWN
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.
        
        
        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
        
        
        Changelog
        =========
        
        This document describes changes between each past release.
        
        4.0.1 (2018-12-10)
        ------------------
        
        **Bug fixes**
        
        - Handle Draftv4 schema validation for empty required.
        
        
        4.0.0 (2018-12-10)
        ------------------
        
        **Breaking changes**
        
        - ``kinto-wizard load`` now expects to find a ``buckets:`` root level in
          the YAML file.  And ``kinto-wizard dump`` will now add it (fixes #59)
        
        **New feature**
        
        - Add a ``validate`` command to run JSON schema validation on the records
          locally. (fixes #61)
        
        **Internal changes**
        
        - To ease the transition between kinto-wizard 3 and kinto-wizard 4,
          handle both for a couple of releases. (#64)
        
        
        3.0.0 (2018-10-17)
        ------------------
        
        **Breaking changes**
        
        - Upgrade to kinto-http.py 10.0 means that the batch will fail if one
          of the server responses has a 4XX status, use the
          ``--ignore-batch-4xx`` to keep the previous behaviour.
        
        **New features**
        
        - Add an ``--ignore-batch-4xx`` option to explicitly ask for silent
          4xx errors.
        
        **Bug fixes**
        
        - Handle YAML date and datetime values. (#51)
        
        **Internal changes**
        
        - Add test for YAML node anchors support (#52)
          See https://en.wikipedia.org/wiki/YAML#Advanced_components
        
        
        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>
        
Keywords: web sync json storage services
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: License :: OSI Approved :: Apache Software License
