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.1.10 (2019-11-12)

  • Be able to customize number of thread pool workers [vangheem]

5.1.9 (2019-11-12)

  • Add custom settings into test server [qiwn]

5.1.8 (2019-11-11)

  • bump

5.1.7 (2019-11-11)

  • Make sure to use txn.lock when using pg connection [vangheem]

5.1.6 (2019-11-08)

  • reduce the load dbvacuum can cause [vangheem]

5.1.6 (unreleased)

  • Fix required param not specified in service parameters configuration [vangheem]

5.1.5 (2019-11-06)

  • Fix test util: add db in task vars too [lferran] [lferran]

  • Added “pickle_protocol” to app_settings [masipcat]

5.1.4 (2019-11-06)

  • Add extra_headers parameter into FileManager.prepare_download() [qiwn]

5.1.3 (2019-11-04)

New:

  • More mypy support and better type checking [vangheem]

  • Added deserializer for IUnionField [masipcat]

  • Provide new @field.validator to validate field values against bound fields [vangheem]

Fixes:

  • Fix @invariant validation. Any usage of it previously would cause exceptions. [vangheem]

5.1.2 (2019-10-30)

  • Handle empty G_ environment variable values [vangheem]

5.1.1 (2019-10-29)

  • more mypy definitions on ITransactionManager

5.1.0 (2019-10-25)

  • Move guillotina_dbusers to guillotina.contrib.dbusers [jordic, lferran]

  • Missed debug information. [bloodbare]

5.0.28 (2019-10-23)

  • Cache debug information should be debug level [bloodbare]

5.0.27 (2019-10-23)

  • Do not fallback to setattr with unhandled errors on fields [vangheem]

5.0.26 (2019-10-21)

  • Documentation and training fixes [vangheem]

5.0.25 (2019-10-21)

  • Documentation and training fixes [vangheem]

  • 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]

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

Uploaded Source

Built Distribution

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