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.0.25 (2019-10-21)

  • Documentation and training fixes [vangheems]

  • Fix compatiblity issues with Python 3.8 [masipcat]

5.0.24 (2019-10-17)

  • Add BucketDictValue.clear() [qiwn]

  • Fix error closing cache with some objects [vangheem]

5.0.23 (2019-10-17)

  • Cache improvements:
    • Store changes in cache immediately after transaction has finished instead of in task

    • Clear txn cache fill data after using it

    • Properly cache annotation lookup misses

5.0.22 (2019-10-16)

  • Fix push invalidation data type [vangheem]

5.0.21 (2019-10-16)

  • add_behavior should only write to database if behavior is new for object [vangheem]

  • Improve cache hit performance by setting cache keys on objects loaded directly by uid and by looking up children object [vangheem]

5.0.20 (2019-10-15)

  • Add event when database tables created for postgres [vangheem]

5.0.19 (2019-10-14)

  • Bucket dict field does not always split index properly [vangheem]

5.0.18 (2019-10-13)

  • Fix connection leaks in edge-cases [masipcat]

  • Pinned asyncpg to 0.19.0 [masipcat]

5.0.17 (2019-10-11)

  • Transaction manager type hints [vangheem]

5.0.16 (2019-10-11)

  • Handle deserialization errors on bucket fields. Otherwise, dict values were getting incorrectly saved [vangheem]

5.0.15 (2019-10-02)

  • Provide workaround for asyncio contextvars ipython bug in shell [vangheem]

5.0.14 (2019-10-02)

  • Throw an TransactionObjectRegistrationMismatchException exception if you attempt to register an object with a transaction that is a different than existing registration for that object. [vangheem]

5.0.13 (2019-09-27)

  • Case insensitive environ G_ variable lookup [svx]

  • Improve reST syntax of README [svx]

  • Fix typo in CHANGELOG [svx]

5.0.12 (2019-09-24)

  • Fix shut down for redis pubsub driver [vangheem]

  • Swagger url support for X-Forwarded-Proto and X-Forwarded-Schema [bloodbare]

5.0.11 (2019-09-18)

  • Fix patch field delete to handle when value is None [vangheem]

  • Adjust Sphinx to build in parallel [svx]

5.0.10 (2019-09-06)

  • Be able to use guillotina’s types in 3rd party apps [vangheem]

5.0.9 (2019-09-05)

  • Handle errors vacuuming [vangheem]

5.0.8 (2019-09-05)

  • pypi package desc fix

5.0.7 (2019-09-05)

  • Explicitly reset task vars on every request [vangheem]

  • Fix futures execute error when no futures are defined for type [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.0.25.tar.gz (6.3 MB view hashes)

Uploaded Source

Built Distribution

guillotina-5.0.25-cp37-cp37m-macosx_10_14_x86_64.whl (5.5 MB view hashes)

Uploaded CPython 3.7m macOS 10.14+ x86-64

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