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.42 (2020-05-26)

  • Allow arbitrary path parameter within the path parameters [dmanchon]

5.3.41 (2020-05-19)

  • Fix import [vangheem]

5.3.40 (2020-05-19)

  • swagger tags fixes [ableeb]
  • Register aiohttp server object with app that it is serving(._server) [vangheem]

5.3.39 (2020-05-11)

  • Handle ConnectionResetError when downloading files [vangheem]

5.3.38 (2020-05-04)

  • Bug fix: handle raw strings in json payload [lferran]

5.3.37 (2020-04-24)

  • swagger tags fixes

5.3.36 (2020-04-24)

  • Provide patch operations for json field [vangheem]
  • Optimize extend operation for bucket list field [vangheem]
  • . and .. should be blocked as valid ids. The browser will auto translate them to what current dir and parent dir respectively which gives unexpected results. [vangheem]

5.3.35 (2020-04-21)

  • Change log level for conflict errors to warning and fix locating tid of conflict error [vangheem]

5.3.34 (2020-04-14)

  • Use bigint for statement replacement values [vangheem]

5.3.33 (2020-03-24)

  • Error handling: ValueDeserializationError editing registry value [vangheem]
  • Handle db transaction closed while acquiring transaction lock [vangheem]
  • Handle db transaction closed while acquiring lock [vangheem]
  • Handle connection errors on file head requests [vangheem]

5.3.32 (2020-03-06)

  • Fix integer query param validation [lferran]

5.3.31 (2020-02-28)

  • Be able to have async schema invariants [vangheem]

5.3.30 (2020-02-24)

  • Provide better validation for json schema field [vangheem]

5.3.29 (2020-02-21)

  • Handle error when “None” value provided for behavior data [vangheem]

5.3.28 (2020-02-20)

  • Handle connection reset errors when downloading files [vangheem]

5.3.27 (2020-02-13)

  • Add max_ops property to PatchField, BucketListField and BucketDictField [vangheem]
  • Add clear action to list, dict and annotation patch fields [vangheem]

5.3.26 (2020-02-12)

  • Improve performance of bucket dict field [vangheem]

5.3.25 (2020-02-11)

  • Fix storages integration with some asyncpg pool settings [vangheem]

5.3.24 (2020-02-06)

  • Fix release [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.

Files for guillotina, version 5.3.42
Filename, size File type Python version Upload date Hashes
Filename, size guillotina-5.3.42-cp37-cp37m-macosx_10_14_x86_64.whl (5.5 MB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size guillotina-5.3.42.tar.gz (6.3 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page