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.57 (2020-10-14)

  • Add metric for object cache records size [lferran]

  • Fix metrics context manager when prometheus not installed [lferran]

5.3.56 (2020-10-14)

  • Fix BasicCache.fill_cache: do not exclude parent_id key for root object [lferran]

5.3.55 (2020-10-01)

  • Add memcached support as cache driver [lferran]

5.3.54 (2020-09-30)

  • increase precision of lock metrics reporting [vangheem]

5.3.53 (2020-09-30)

  • Add metrics for in-memory cache [vangheem]

5.3.52 (2020-09-30)

  • Move to github actions [lferran]

  • Add id checker for move [qiwn]

5.3.51 (2020-09-24)

  • Record metrics on cache hit/misses [vangheem]

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

5.3.50 (2020-09-23)

  • Record redis cache misses [vangheem]

5.3.49 (2020-09-22)

  • Add metrics to pg and redis operations [vangheem]

5.3.48 (2020-09-09)

  • Add IFileNameGenerator adapter [qiwn]

5.3.47 (2020-06-25)

  • Include bugfix version for aiohttp in setup.py [lferran]

5.3.46 (2020-06-17)

  • Fix registry update, when type provided mismatch with the one specified by the schema return an error HTTP status code instead of throwing an exception. [pfreixes]

5.3.45 (2020-06-11)

  • Fix: Be able to define optional requestBody [lferran]

5.3.44 (2020-06-11)

  • Be able to define optional requestBody [lferran]

5.3.43 (2020-06-07)

  • Optimize json schema ref resolution to not make so copies of all json schema definition for every validator instance [vangheem]

  • Fix json schema ref resolution for nested objects [vangheem]

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]

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.57.tar.gz (6.4 MB view details)

Uploaded Source

File details

Details for the file guillotina-5.3.57.tar.gz.

File metadata

  • Download URL: guillotina-5.3.57.tar.gz
  • Upload date:
  • Size: 6.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for guillotina-5.3.57.tar.gz
Algorithm Hash digest
SHA256 310514b27fbd3a4e187fb4f92b7fd49ebbdd7091a0da57f98135057f1c9606c8
MD5 2bb29330b8731222d1f9e9831c350feb
BLAKE2b-256 eacb5d94be6852c11c6b64bab5a32aff6ba115d6efeafca495345cc1b35732e8

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