Metadata-Version: 2.1
Name: guillotina
Version: 6.4.0
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
Keywords: asyncio,REST,Framework,transactional,asgi
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: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7.0
Provides-Extra: test
Provides-Extra: docs
Provides-Extra: testdata
Provides-Extra: redis
Provides-Extra: mailer
Provides-Extra: memcached
Provides-Extra: validation
Provides-Extra: recaptcha
License-File: LICENSE

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

.. image:: https://img.shields.io/docker/cloud/build/plone/guillotina
   :target: https://hub.docker.com/r/guillotina/guillotina
   :alt: Docker Cloud Build Status

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 \
        plone/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
=========

6.4.0 (2022-04-12)
------------------

- Fix PubSub utility stuck in infinite loop when Redis connection is interrupted
  [masipcat]


6.4.0rc3 (2022-03-16)
---------------------

- Fix Pillow dependency
  [bloodbare]

- Breaking change: guillotina futures won't have the txn set anymore.
  [masipcat]

- Fix @pytest.mark.app_settings modified original settings dictionary
  [masipcat]

- Fix previous change in mailer utility
  [masipcat]

- Improve error logging in futures
  [masipcat]
- Documentation: Enhance search endpoint documentation
  [ksuess]
- Documentation: Add info about catalog_max_results
  [ksuess]

- Add a dict parameter `render_options` to pass custom values to
  rendered template in EmailValidationUtility
  [jotare]

6.4.0rc2 (2021-11-22)
---------------------

- Nothing changed yet.


6.4.0rc1 (2021-11-22)
---------------------

- Some fixes and improvements to the new TransactionConnectionContextManager
  [masipcat]

- Port the following changes:
- Remove db transaction strategy support
- Try not to reserve connection when possible
  [vangheem]

- Black to 21.10b0 version
  [bloodbare]

- Add the possibility of configuring the ttl of the email_validation
  using app_settings["ttl_email_validation"] in the utility of the
  email_validation. By default is 3660s.
  [nilbacardit26]
- Fix docs: Create group with id/name
  [ksuess]

- doc: installation: fix duplicated line and link to contrib/dbusers
  [jotare]


6.4.0rc0 (2021-10-20)
---------------------

- Add support for Python 3.10
  [masipcat]
- Reimplemented IRedisUtility to adapt to aioredis v2.0 breaking changes
  [masipcat]
- Removed argument 'loop' from utilities initialization (following Python 3.10 changes)
  [masipcat]
- Upgraded dev dependencies
  [masipcat]

- Fix searching by SearchableText
  [frapell]

- Fix vocabulray country code AN

6.3.15 (2021-08-05)
-------------------

- fix: Add MIMEMultipart('alternative') to attach message in parent MIMEMultipart to render only html body.
  [rboixaderg]

6.3.14 (2021-08-04)
-------------------

- feat: Change MIMEMultipart 'alternative' to 'mixed'. Outlook and Thunderbird not recieve attachment when use 'alternative'
- chore: fix version aioredis 1.3.1
  [rboixaderg]


6.3.13 (2021-07-05)
-------------------

- Mask Textline field to recover masked values on get
  [bloodbare]

- Fix navigate_to() crashes with 'AttributeError' when traversing to a non-folderish object
  [masipcat]


6.3.12 (2021-07-01)
-------------------

- shell: import 'app_settings'. Fix typo
- doc: Fix example app and other small fixes
  [jianaijun]
- feat: Add null and not null operator in int, float and timestamp types in pgcatalog
  [rboixaderg]


6.3.11 (2021-06-10)
-------------------

- Add is not null operator Search pgcatalog
- Fix order by int and float Search pgcatalog
  [rboixaderg]


6.3.10 (2021-06-07)
-------------------

- Fix unrestricted Search pgcatalog
- Add filter is null Search pgcatalog
  [rboixaderg]


6.3.9 (2021-05-31)
------------------

- Allow to define custom validate url and custom template on email actions
  [bloodbare]
- Add @ in allowed chars in IIDChecker
  [rboixaderg]


6.3.8 (2021-05-21)
------------------

- Fixing status code on range request
  [bloodbare]


6.3.7 (2021-05-21)
------------------

- Fix potential pg connection leaks
- PG Catalog unrestricted search build count query
- PG Catalog __or, __and operators
  [rboixaderg]


6.3.6 (2021-05-10)
------------------

- Fix error on unrestricted Search
  [bloodbare]


6.3.5 (2021-05-10)
------------------

- PG Catalog unrestricted search
  [bloodbare]


6.3.4 (2021-05-06)
------------------

- Adding image with scale previews field
  [bloodbare]


6.3.3 (2021-05-04)
------------------

- Command: Implement graceful stop (like in asyncio.run())
  [masipcat]

- Command: Fix same txn copied to all tasks/requests
  [masipcat]


6.3.2 (2021-04-30)
------------------

- Command: fix typo introduced in #1125
  [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.



