guillotina 7.0.6
asyncio REST API Resource database
License: BSD
Requires Python: >=3.7.0
Keywords: asyncio, REST, Framework, transactional, asgi

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
=========

7.0.6 (2025-10-10)
------------------

- Adding POST @groups endpoint in dbusers
- Upgrading postgres version when running test in conftest
- Updating .readthedocs.yml to version 2. Updating docs dependencies,
  upgrading sphinx to version 8
  [nilbacardit26]
- Adding serve-reload command to run the server with auto-reload
- Updated role definitions in permissions.py to include default values for 'guillotina.Member' and 'guillotina.Manager' to ensure the correct parameters are passed to the role.
- Modified ListGroups and ListUsers services to include '@id' and 'username' fields in the response.
- Use the group name as the ID in groups if it is provided.
- Updated @users and @groups endpoints to adapt them to volto/plone api
- Fixed updating users in groups in custom and standard API
  [rboixaderg]

7.0.5 (2025-04-03)
------------------

- Adding cc argument in mailer's send coroutine


7.0.4 (2025-03-25)
------------------

- Trigger notify event when user_manager folder is created, and also for group_manager.
- Refactor CockroachDB storage integration to work with the latest version of Cockroach.
- Upgrade Pillow to the latest version.
- Upgrade mypy and adjust setup.cfg to improve compatibility with the existing codebase.
  [nilbacardit26]
- Integrating the @count endpoint into the catalog interface and
  implementing the associated functionality for pg catalog.
  [nilbacardit26]

7.0.3 (2024-10-01)
------------------

- Calling register and notify when sorting OrderedDicts
- Calling register and notify when deleting file keys
  [nilbacardit26]


7.0.2 (2024-01-23)
------------------

- Dummy Release [bloodbare]


7.0.1 (2024-01-23)
------------------

- Being able to use schema.Time [nilbacardit26]
- Feat: Add metadata info to workflows
- Fix: Update workflow vocabulary name
- Feat: Update workflow vocabulary title attribute to use metadata
  [rboixaderg]


7.0.0 (2023-12-06)
------------------

- BREAKING CHANGE: Passging sql_copy_from_where and jit parameters to
  asyncpg.connection.ServerCapabilities and pinning asyncpg in
  requirements to 0.29.0. Dropping 3.7.0 python support
  [nilbacardit26]

6.4.5 (2023-11-28)
------------------

- Fix: Index full object after move it
  [rboixaderg]

- Chore: Update multidict dependency
  [rboixaderg]


6.4.4 (2023-11-20)
------------------

- Removing implements import in components/interfaces.py
  [nilbacardit26]


6.4.3 (2023-10-11)
------------------

- Fix not checking if the ID is valid when duplicating a resource
  [masipcat]

- Fix content.async_get() catches KeyError exceptions unrelated to txn.get_child()
  [masipcat]

- Deps: replace aioredis with redis-py
  [masipcat]

- Deps: updated flake8 so it won't depend on 'importlib-metadata<5'
  [masipcat]

- Fix path__starts. Add a slash when parsing the path of the query if
  the context of the search is not the container, to avoid getting the
  results of contexts that starts with the same path.
  [nilbacardit26]

- Adding render_options when registering a user.
  [nilbacardit26]

- Adding OrderedDict field, and exposing @orderImages to the images'
  api to order the keys of a field
  [nilbacardit26]


6.4.2 (2022-08-25)
------------------

- Being able to call do_action with super powers in the Workflow
  utility
  [nilbacardit26]


6.4.1 (2022-07-27)
------------------

- Fix build count query, PG catalog, ignore null and format tuple type. 
  [rboixaderg]


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]



...

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.