Skip to main content

asyncio REST API Resource database

Project description

Introduction

https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat CI Status Test Coverage Python Versions https://img.shields.io/pypi/v/guillotina.svg License Chat Docker Cloud Build Status

Please read the detailed docs

This is the working project of the next generation Guillotina server based on asyncio.

Dependencies

  • Python >= 3.8

  • PostgreSQL >= 9.6

Quickstart

We use pip

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

make run-postgres

Run the server

To run the server

g

Then…

curl http://localhost:8080

Or, better yet, use Postman 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://www.herokucdn.com/deploy/button.svg

Getting started with development

Using pip (requires Python > 3.7)

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

./bin/pytest guillotina

and for test coverage

./bin/pytest --cov=guillotina guillotina/

With file watcher…

./bin/ptw guillotina --runner=./bin/py.test

To run tests with cockroach db

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

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

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.1.2 (2026-05-22)

  • MCP: remove redundant serialize_resource and confusing notify_modified built-in tools. Use resolve_path with include_serialized=true for full resource JSON. [rboixaderg]

  • Copy backing file storage when duplicating content with cloud file fields, including dict-valued multi-file fields, so duplicated content does not share mutable file blobs with the source object. [nilbacardit26]

  • Replace the docs build usage of deprecated pkg_resources with importlib.metadata and update sphinxcontrib-httpexample for compatibility with current setuptools. [nilbacardit26]

7.1.1 (2026-05-15)

  • Fix list-valued mailer recipient headers for To and Cc. [nilbacardit26]

7.1.0 (2026-05-07)

  • BREAKING CHANGE: Drop support for Python 3.8 and 3.9. Guillotina is now tested and supported on Python 3.10, 3.11, and 3.12. [nilbacardit26]

  • Add guillotina.contrib.mcp with low-level MCP server integration (mcp.server.lowlevel), tool registry utility, MCP services, cache invalidation subscribers, and tests/docs coverage.

  • Optimize MCP list_children tool to prefer catalog queries and fallback to async_items when catalog is unavailable.

  • Upgrade the pytest stack so the CI test environment stays compatible with the optional MCP SDK and its AnyIO pytest plugin on Python 3.10+. [finalchaz, nilbacardit26]

  • Docs: Update documentation and configuration settings

  • Chore: Update sphinx-guillotina-theme version to 1.0.9 [rboixaderg]

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]

You are seeing a truncated changelog.

You can read the changelog file for a complete list.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

guillotina-7.1.2.tar.gz (7.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

guillotina-7.1.2-cp313-cp313-macosx_11_0_arm64.whl (6.4 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

File details

Details for the file guillotina-7.1.2.tar.gz.

File metadata

  • Download URL: guillotina-7.1.2.tar.gz
  • Upload date:
  • Size: 7.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.6

File hashes

Hashes for guillotina-7.1.2.tar.gz
Algorithm Hash digest
SHA256 31d22d903d071e18046d2cba84c6b59253151452aa7173de31db39906e1d2baa
MD5 a971a36bf325330e9d6da59a4cf233c8
BLAKE2b-256 cdefbab51f3bcd904095de10ca886a73c128bc523d38dc5ad1ef1c84a734d317

See more details on using hashes here.

File details

Details for the file guillotina-7.1.2-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for guillotina-7.1.2-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 249d6b8e043e62ff13f743fbaa95d8421f0ab56b0e5ba2dba852fac5426e694f
MD5 8571ff7264d798635b0763e7f4fa0efc
BLAKE2b-256 575c363c143dfe2f94e0972a0a19c2e4a3ee1e747d619bdb2c794bd7c23be824

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page