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.18 (2020-01-31)

  • add IAnnotations.async_del type annotation [vangheem]

5.3.17 (2020-01-31)

  • Add pg db constraint for annotation data [vangheem]

5.3.16 (2020-01-30)

  • more IRequest type hints [vangheem]

5.3.15 (2020-01-30)

  • Add json to IRequest for mypy [vangheem]

5.3.14 (2020-01-28)

  • Fix DummyCache type signature to be the same as base class [vangheem]

5.3.13 (2020-01-22)

  • Correctly bubble http errors for file downloads [vangheem]

5.3.12 (2020-01-21)

  • Add title/description to json schema field serialization [vangheem]

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]

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.18.tar.gz (6.3 MB view hashes)

Uploaded Source

Built Distribution

guillotina-5.3.18-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