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 Docker Cloud Build Status

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 \
    plone/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

6.0.20 (2020-12-17)

  • Update uvicorn to 0.13.1 [bloodbare]

  • Adding widget field on json schema [bloodbare]

  • Update orjson to 3.x [waghanza]

6.0.19 (2020-12-15)

  • Update gmi [jordic]

  • Search by text by rank if its on search paramaters otherwise by alpha order [bloodbare]

6.0.18 (2020-12-05)

  • doc: training: fix websockets in G6 [masipcat]

  • doc: training: revert a change in api.md [masipcat]

  • Fix watch/watch_lock when prometheus is not installed [masipcat]

6.0.17 (2020-12-04)

  • Adding timezone on email validation link expiration [bloodbare]

  • Adding metadata endpoint to inspect query parameters for the search endpoint [bloodbare]

  • Adding workflow/email_validation/vocabularies documentation [bloodbare]

  • Bytes serializer [bloodbare]

  • doc: improve training [masipcat]

  • Record metrics on cache hit/misses [vangheem]

  • Record metrics on time waiting for pg locks [vangheem]

  • Record redis cache misses [vangheem]

  • Add metrics to pg and redis operations [vangheem]

6.0.16 (2020-11-27)

  • Fixing workflow exception if not defined [bloodbare]

  • Allow to define date format for recovery password [bloodbare]

  • Abort transaction if tpc_commit() crashes [masipcat]

6.0.15 (2020-11-25)

  • Fix not defined workflow exception [bloodbare]

6.0.14 (2020-11-25)

  • Fix reset password flow to be equal to register [bloodbare]

6.0.13 (2020-11-23)

  • Allowing to define Owner roles users on creation [bloodbare]

6.0.12 (2020-11-15)

  • Fixing workflow subscriber for state history [bloodbare]

  • Allow to search on basic workflow state publish [bloodbare]

6.0.11 (2020-11-08)

  • Adding Vocabularies API compatible to Plone REST API [bloodbare]

  • Adding Workflow contrib package with API compatible to Plone REST API [bloodbare]

  • Adding languages and contrib vocabulary [bloodbare]

  • Avoid default value check on get for each get operation [bloodbare]

  • Adding post serialize mechanism to modify JSON responses based on packages [bloodbare]

6.0.10 (2020-11-01)

  • Fix conflict cors response. [bloodbare]

6.0.9 (2020-10-30)

  • Change transaction strategy ‘simple’ [masipcat]

  • Fix bug on error deserialization

  • Fix transaction context manager doesn’t abort the txn when a exception is raised [masipcat]

  • Add id checker for move [qiwn]

6.0.8 (2020-09-24)

  • mailer: import ‘aiosmtplib’ and ‘html2text’ lazily [masipcat]

  • Cleanup travis logic from test fixtures [lferran]

  • settings: always convert ‘pool_size’ to int [masipcat]

6.0.7 (2020-09-09)

  • Add IFileNameGenerator adapter [qiwn]

6.0.6 (2020-08-25)

  • Pass ‘server_settings’ in ‘connection_options’ to asyncpg pool [masipcat]

6.0.5 (2020-08-11)

  • Fix register schema [bloodbare]

  • Fix async test without pytest mark [masipcat]

6.0.4 (2020-07-29)

  • fix release

6.0.3 (2020-07-29)

  • Cookiecutter: fix test_install.py [masipcat]

  • test deps: unpin pytest-asyncio [masipcat]

  • doc: fix md headers (h1 -> h2) and other small fixes [masipcat]

  • doc: fix example app [masipcat]

  • Fix sphinx-build [masipcat]

  • Make sure it does not fail on empty field [bloodbare]

6.0.2 (2020-07-10)

  • Set load_catalog=true in test settings [masipcat]

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

Uploaded Source

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