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.3.11 (2020-01-16)

  • Better error handling on redis connection issues [vangheem]

5.3.10 (2020-01-16)

  • JSON Schema and open api serialization fixes [vangheem]

5.3.9 (2020-01-15)

  • Fix validating array params in query parameters [lferran]

  • Add open api tests and fix ones that do not pass tests [vangheem]

5.3.8 (2020-01-15)

  • Fix automatic type conversion on nested fields [vangheem]

5.3.7 (2020-01-13)

  • Fix automatic type conversion on nested fields. Fixes #832 [vangheem]

5.3.6 (2020-01-09)

  • Be able to start database transaction before transaction has started it without causing errors [vangheem]

5.3.5 (2020-01-09)

  • Fix optimized lookup to work with fields that do not have _type [vangheem]

5.3.4 (2020-01-07)

  • Fix query param validation [vangheem]

5.3.3 (2020-01-07)

  • Optimize json deserialization [vangheem]

  • Update Dockerfile [svx]

5.3.2 (2020-01-03)

  • Be able to disable supporting range headers in IFileManager.download [vangheem]

  • Make Field.required an optional property. To change default required behavior, you can monkey patch IField[‘required’].default = False [vangheem]

5.3.1 (2020-01-02)

  • Save old file attrs before content is cleaned [vangheem]

5.3.0 (2020-01-02)

  • Add Range header support [vangheem]

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]

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.3.11.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.3.11-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.3.11.tar.gz.

File metadata

  • Download URL: guillotina-5.3.11.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.3.11.tar.gz
Algorithm Hash digest
SHA256 ecf17ef97a7b29bdc63f6247741ba4dd3ea03e239a017ed3948f90c6e6b3b0df
MD5 3a9ce8bcb1b1935d47f0386e5eb92cd0
BLAKE2b-256 65e780f82fc0d83262f77d0d0f9c628c34516db4fcb2d6f88ed779d926c741ec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: guillotina-5.3.11-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.3.11-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 ca8fc24301f426c36f3fd65f53837052e4f3294ece4be31edafb34abcc09123a
MD5 fde04018b40c379126d4ced8f275b55a
BLAKE2b-256 4cebdcc09de643ed0d5152e44bc32f5b3cfbd47d4ed76c1d59901b091f9cf5c7

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