Metadata-Version: 2.1
Name: guillotina
Version: 5.0.23
Summary: asyncio REST API Resource database
Home-page: https://github.com/plone/guillotina
Author: Ramon Navarro Bosch & Nathan Van Gheem
Author-email: ramon@plone.org
License: BSD
Description: Introduction
        ============
        
        .. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
           :target: http://guillotina.readthedocs.io/en/latest/
        
        .. image:: https://travis-ci.org/plone/guillotina.svg?branch=master
           :target: https://travis-ci.org/plone/guillotina
        
        .. image:: https://codecov.io/gh/plone/guillotina/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/plone/guillotina/branch/master
           :alt: Test Coverage
        
        .. image:: https://img.shields.io/pypi/pyversions/guillotina.svg
           :target: https://pypi.python.org/pypi/guillotina/
           :alt: Python Versions
        
        .. image:: https://img.shields.io/pypi/v/guillotina.svg
           :target: https://pypi.python.org/pypi/guillotina
        
        .. image:: https://img.shields.io/pypi/l/guillotina.svg
           :target: https://pypi.python.org/pypi/guillotina/
           :alt: License
        
        .. image:: https://badges.gitter.im/plone/guillotina.png
           :target: https://gitter.im/plone/guillotina
           :alt: Chat
        
        Please `read the detailed docs <http://guillotina.readthedocs.io/en/latest/>`_
        
        
        This is the working project of the next generation Guillotina server based on asyncio.
        
        
        Dependencies
        ------------
        
        * Python >= 3.7
        * PostgreSQL >= 9.6
        
        
        Quickstart
        ----------
        
        We use pip
        
        .. code-block:: shell
        
            pip install guillotina
        
        
        Run PostgreSQL
        --------------
        
        If you don't have a PostgreSQL server to play with, you can run one with Docker.
        
        Download and start the Docker container by running
        
        .. code-block:: shell
        
            make run-postgres
        
        
        
        Run the server
        --------------
        
        To run the server
        
        .. code-block:: shell
        
            g
        
        
        Then...
        
        .. code-block:: shell
        
            curl http://localhost:8080
        
        
        Or, better yet, use `Postman <https://www.getpostman.com/>`_ to start playing with API.
        
        You can also navigate in your Guillotina server with its built-in web admin interface by visiting http://localhost:8080/+admin/.
        
        Deploy on Heroku
        ----------------
        
        Read more `Guillotina-Heroku <https://github.com/guillotinaweb/guillotina-heroku>`_.
        
        .. image:: https://www.herokucdn.com/deploy/button.svg
           :target: https://www.heroku.com/deploy?template=https://github.com/guillotinaweb/guillotina-heroku
        
        Getting started with development
        --------------------------------
        
        Using pip (requires Python > 3.7)
        
        .. code-block:: shell
        
            git clone git@github.com:plone/guillotina.git
            cd guillotina
            python3.7 -m venv .
            ./bin/pip install -r requirements.txt
            ./bin/pip install -r contrib-requirements.txt
            ./bin/pip install -e .[test]
            ./bin/pre-commit install
        
        
        Run tests
        ---------
        
        We're using `pytest <https://docs.pytest.org/en/latest/>`_
        
        .. code-block:: shell
        
            ./bin/pytest guillotina
        
        and for test coverage
        
        .. code-block:: shell
        
            ./bin/pytest --cov=guillotina guillotina/
        
        With file watcher...
        
        .. code-block:: shell
        
            ./bin/ptw guillotina --runner=./bin/py.test
        
        
        To run tests with cockroach db
        
        .. code-block:: shell
        
            USE_COCKROACH=true ./bin/pytest guillotina
        
        Default
        -------
        
        Default root access can be done with AUTHORIZATION header : Basic root:root
        
        
        Docker
        ------
        
        You can also run Guillotina with Docker!
        
        
        First, run PostgreSQL
        
        .. code-block:: shell
        
            docker run --rm \
                -e POSTGRES_DB=guillotina \
                -e POSTGRES_USER=guillotina \
                -p 127.0.0.1:5432:5432 \
                --name postgres \
                postgres:9.6
        
        Then, run Guillotina
        
        .. code-block:: shell
        
            docker run --rm -it \
                --link=postgres -p 127.0.0.1:8080:8080 \
                guillotina/guillotina:latest \
                g -c '{"databases": [{"db": {"storage": "postgresql", "dsn": "postgres://guillotina:@postgres/guillotina"}}], "root_user": {"password": "root"}}'
        
        
        This assumes you have a config.yaml in your current working directory
        
        
        Chat
        ----
        
        Join us to talk about Guillotina at https://gitter.im/plone/guillotina
        
        
        CHANGELOG
        =========
        
        5.0.23 (2019-10-17)
        -------------------
        
        - Cache improvements:
            - Store changes in cache immediately after transaction has finished instead of in task
            - Clear txn cache fill data after using it
            - Properly cache annotation lookup misses
        
        
        5.0.22 (2019-10-16)
        -------------------
        
        - Fix push invalidation data type
          [vangheem]
        
        
        5.0.21 (2019-10-16)
        -------------------
        
        - `add_behavior` should only write to database if behavior is new for object
          [vangheem]
        
        - Improve cache hit performance by setting cache keys on objects loaded
          directly by uid and by looking up children object
          [vangheem]
        
        5.0.20 (2019-10-15)
        -------------------
        
        - Add event when database tables created for postgres
          [vangheem]
        
        
        5.0.19 (2019-10-14)
        -------------------
        
        - Bucket dict field does not always split index properly
          [vangheem]
        
        
        5.0.18 (2019-10-13)
        -------------------
        
        - Fix connection leaks in edge-cases
          [masipcat]
        
        - Pinned asyncpg to 0.19.0
          [masipcat]
        
        
        5.0.17 (2019-10-11)
        -------------------
        
        - Transaction manager type hints
          [vangheem]
        
        
        5.0.16 (2019-10-11)
        -------------------
        
        - Handle deserialization errors on bucket fields. Otherwise, dict values were getting incorrectly saved
          [vangheem]
        
        
        5.0.15 (2019-10-02)
        -------------------
        
        - Provide workaround for asyncio contextvars ipython bug in shell
          [vangheem]
        
        
        5.0.14 (2019-10-02)
        -------------------
        
        - Throw an `TransactionObjectRegistrationMismatchException` exception if you attempt to
          register an object with a transaction that is a different than existing registration
          for that object.
          [vangheem]
        
        
        5.0.13 (2019-09-27)
        -------------------
        
        - Case insensitive environ `G_` variable lookup
          [svx]
        
        - Improve reST syntax of README
          [svx]
        
        - Fix typo in CHANGELOG
          [svx]
        
        5.0.12 (2019-09-24)
        -------------------
        
        - Fix shut down for redis pubsub driver
          [vangheem]
        
        - Swagger url support for X-Forwarded-Proto and X-Forwarded-Schema
          [bloodbare]
        
        
        5.0.11 (2019-09-18)
        -------------------
        
        - Fix patch field delete to handle when value is None
          [vangheem]
        
        - Adjust Sphinx to build in parallel
          [svx]
        
        
        5.0.10 (2019-09-06)
        -------------------
        
        - Be able to use guillotina's types in 3rd party apps
          [vangheem]
        
        
        5.0.9 (2019-09-05)
        ------------------
        
        - Handle errors vacuuming
          [vangheem]
        
        
        5.0.8 (2019-09-05)
        ------------------
        
        - pypi package desc fix
        
        
        5.0.7 (2019-09-05)
        ------------------
        
        - Explicitly reset task vars on every request
          [vangheem]
        
        - Fix futures execute error when no futures are defined for type
          [vangheem]
        
        
        5.0.6 (2019-09-04)
        ------------------
        
        - Fix `execute.clear_futures()`
          [vangheem]
        
        - Adding Helm Charts
          [karannaoh]
        
        5.0.4 (2019-09-04)
        ------------------
        
        - Upgrade mypy
          [vangheem]
        
        - Fix not setting cache values for updated object when push is not enabled
          [vangheem]
        
        - Fix conflict error handling with registry objects
          [vangheem]
        
        - Sorted imports in all files and added `isort` in .travis to keep the format
          [masipcat]
        
        
        
        ...
        
        You are seeing a truncated changelog.
        
        You can read the `changelog file <https://github.com/plone/guillotina/blob/master/CHANGELOG.rst>`_
        for a complete list.
        
        
Keywords: asyncio,REST,Framework,transactional
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7.0
Provides-Extra: docs
Provides-Extra: test
Provides-Extra: redis
Provides-Extra: mailer
