Skip to main content

asyncio REST API Resource database

Project description

Introduction

https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat https://travis-ci.org/plone/guillotina.svg?branch=master Test Coverage Python Versions https://img.shields.io/pypi/v/guillotina.svg License Chat

Please read the detailed docs

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

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 \
    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.2.2 (2019-12-27)

  • Fix validating None values in required fields [vangheem]

5.2.1 (2019-12-21)

  • Fix error with requeued async queue tasks [vangheem]

5.2.0 (2019-12-20)

  • Added IIDChecker adapter [vangheem]

  • Added valid_id_characters app setting [vangheem]

5.1.26 (2019-12-20)

  • Bubble cancelled errors in resolver [vangheem]

  • Fix duplicate behaviors interfaces in get_all_behavior_interfaces() [qiwn]

5.1.25 (2019-12-18)

  • Better CancelledError handling in resolving a request [vangheem]

  • Fix adding duplicate behaviors [qiwn]

  • PatchField: added operation “multi” [masipcat]

5.1.24 (2019-12-16)

  • @duplicate: added option to reset acl [inakip]

5.1.23 (2019-12-11)

  • Make pytest.mark.app_settings work in older pytest versions too [lferran]

  • @move: destination id conflict should return 409 error, not 412 [inaki]

5.1.22 (2019-12-02)

  • Fix security bug in @move and @duplicate [lferran]

5.1.21 (2019-11-29)

  • Allow to iterate keys, values and items of a BucketDictValue [lferran]

5.1.20 (2019-11-27)

  • Fix security bug: anonymous users were being granted guillotina.Authenticated [lferran]

5.1.19 (2019-11-19)

  • Update default zope.interface to 4.7.1 [bloodbare]

  • Be able to provide DEBUG_SUBSCRIBERS env variable to get details about event timings being run. [vangheem]

5.1.18 (2019-11-25)

  • Make sure to reset registry task var when setting up new container [vangheem]

5.1.17 (2019-11-22)

  • Fix potential deadlock issues when storage read conn handling [vangheem]

5.1.16 (2019-11-21)

  • Allow uid as destination in @duplicate and @move [qiwn]

5.1.15 (2019-11-20)

  • Fix correctly saving patch field [vangheem]

5.1.14 (2019-11-20)

  • Fix patch field validation [vangheem]

5.1.13 (2019-11-13)

  • Prevent JSONField name clash with field validator decorator [vangheem]

5.1.12 (2019-11-12)

  • Remove task call back to run execute_futures automatically. aiohttp reuses task object for keepalive implementation and the _callbacks were never run [vangheem]

5.1.11 (2019-11-12)

  • Lazy create thread pool executor so we can properly use thread pool setting [vangheem]

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-5.2.2.tar.gz (6.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-5.2.2-cp37-cp37m-macosx_10_14_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.7mmacOS 10.14+ x86-64

File details

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

File metadata

  • Download URL: guillotina-5.2.2.tar.gz
  • Upload date:
  • Size: 6.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for guillotina-5.2.2.tar.gz
Algorithm Hash digest
SHA256 e2d212742a1a215ea5288db1aa1171d112c6a46c08992ef45d65546acfff5f33
MD5 4342486193f182bef53a34b68faae2c8
BLAKE2b-256 619a31cc1d3902736d1b120925c37c93e1e8132ea048d36768f1eeefb1f44b3d

See more details on using hashes here.

File details

Details for the file guillotina-5.2.2-cp37-cp37m-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: guillotina-5.2.2-cp37-cp37m-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 5.5 MB
  • Tags: CPython 3.7m, macOS 10.14+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for guillotina-5.2.2-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 31753995c39c5cea7130403ac1b07646ae2bc0d56147741424340470f1fe51e0
MD5 ffbd6d92af6486d1efed49c759804b98
BLAKE2b-256 a1d39ee203f30fb365e2c5397642c3ccc47d0dc7761fb814a5cfedb0b192398c

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