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.6

  • 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 easily 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.6):

git clone git@github.com:plone/guillotina.git
cd guillotina
python -m venv .
./bin/pip install -r requirements.txt
./bin/pip install -e .[test]

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

4.8.15 (2019-07-23)

  • Make sure field name of patch field is set before using [vangheem]

4.8.14 (2019-07-23)

  • Fix: just skip indexing attributes from schemas that object does not adapt to [lferran]

  • Improve request memory usage [vangheem]

4.8.13 (2019-07-15)

  • Allow modifying app settings from pytest marks [lferran]

  • Merge CORS headers [qiwn]

  • Fix managed_transaction() crashes when request and tm are not provided [masipcat]

4.8.12 (2019-07-08)

  • Handle CancelledError on application cleanup. This seems to happen with uvloop [vangheem]

4.8.11 (2019-06-28)

  • Cache JSONField schema validator object [vangheem]

  • JSONField works with dict instead of requiring str(which is then converted to dict anyways) [vangheem]

  • A few more antipattern fixes [lferran]

4.8.10 (2019-06-26)

  • Fix indexing data potentially missing updated content when fields for accessor is not specified [vangheem]

  • Fix events antipattern [lferran]

4.8.9 (2019-06-17)

  • bump

4.8.8 (2019-06-17)

  • Emit events for registry configuration changes [vangheem]

4.8.7 (2019-06-14)

  • Add field mappings for test field [lferran]

4.8.6 (2019-06-10)

  • Fix @move enable to allow being able to use it for renaming [vangheem]

4.8.5 (2019-06-07)

  • Be compatible with aiohttp > 3 < 4 [vangheem]

  • Make sure utility you are providing also provides the interface you are creating it for in load_utilities. Before, it would not automatically apply the interface for you. [vangheem]

4.8.4 (2019-06-06)

  • Fix aiohttp startup bug [vangheem]

  • propagate unique violation errors on deletion as they should not happen anymore unless db hasn’t been migrated [vangheem]

4.8.3 (2019-06-06)

  • Upgrade to aiohttp 3.5.0 [vangheem]

4.8.2 (2019-05-28)

  • Fix bug where non-async object subscribers were getting called twice [vangheem]

4.8.2 (unreleased)

  • Nothing changed yet.

4.8.1 (2019-05-25)

  • Improve startup speed by not using glogger for startup code [vangheem]

  • Support zope.Interface inheritance in schema.Object [masipcat]

4.8.0 (2019-05-13)

  • get_object_by_oid now raises KeyError since it provided unsafe behavior when used with tombstoned objects [vangheem]

4.7.8 (2019-05-06)

  • Fix potential memory leak in security lookup cache [vangheem]

  • Fix security policy cache lookup to distinguish between types of cached decisions for parent vs top level object [vangheem]

4.7.7 (2019-05-01)

  • Fix json schema definitions and provide get_schema_validator utility [vangheem]

  • Fix managed_transaction context manager to correctly adopt parent transaction along with new transaction objects [vangheem]

4.7.6 (2019-04-28)

  • Provide connection_settings on the request object with tests.utils.get_container [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-4.8.15.tar.gz (5.9 MB view hashes)

Uploaded Source

Built Distribution

guillotina-4.8.15-py3-none-any.whl (5.4 MB view hashes)

Uploaded Python 3

Supported by

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