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.3.1 (2021-04-30)

  • On workflow change also trigger object modification [bloodbare]

  • Command: run the startup/shutdown and main logic inside the loop [masipcat]

6.3.0 (2021-04-21)

  • Use Context on default catalog security checks [bloodbare]

  • Return 401 if NoPermissionToAdd is raised in defaultPOST [nilbacardit26]

  • No longer have dedicated read connection and do not use any prepared statements [vangheem]

6.2.6 (2021-04-12)

  • Fix bug on search results ids based on container path [bloodbare]

6.2.5 (2021-04-09)

  • Fix PGCatalog Phrase search [bloodbare]

  • Fix bug on empty waiting for empty tasks. [bloodbare]

6.2.4 (2021-04-07)

  • Enable X-Wait header to wait futures. Use only in case you need to make sure all futures are finished before request ends. Alert: Afects performance on request response time. [bloodbare]

6.2.3 (2021-04-07)

  • Search on pg catalog should check security on context [bloodbare]

6.2.2 (2021-04-01)

  • Index on PG Catalog IDS should be table named [bloodbare]

6.2.1 (2021-03-12)

  • Allow to skip pg catalog initialization based on SKIP_PGCATALOG_INIT environmental var. [bloodbare]

6.2.0 (2021-03-04)

  • Write missing_value to object on deserialization [masipcat]

  • BREAKING CHANGE: PG Catalog implementation splitted on multiple fields if you are import PGSearchUtility you need to change the import line from: from guillotina.contrib.catalog.pg import PGSearchUtility to from guillotina.contrib.catalog.pg.utility import PGSearchUtility [bloodbare]

6.1.7 (2021-03-03)

  • ISecurityInfo: field ‘id’ was missing [masipcat]

6.1.6 (2021-02-25)

  • Reuse modified objects on same transactions on traversal/async_get navigation [bloodbare]

  • Improve memcached metrics probe [lferran]

6.1.5 (2021-02-09)

  • Cleaner memcached_container pytest fixture [lferran]

  • Fixing checking field permission on content creation [bloodbare]

  • Fix memcached tests not able to start docker image [lferran]

  • Fixing 6.1.4 release (anonymous users not working on search) [bloodbare]

6.1.4 (2021-01-31)

  • Apply local roles on @search with pgcatalog [bloodbare]

6.1.3 (2021-01-18)

  • Fix: patch a role on dbusers:groups don’t remove users from them [jordic]

  • Fix: patching password on a user hash it [jordic]

  • Fix: only allow lowercase usernames on dbusers creation [jordic]

  • Feat: db_users, being able to login by email [jordic]

6.1.2 (2021-01-18)

  • Fix filter and sort by date field on pgcatalog [bloodbare]

  • Add memcached support as cache driver [lferran]

  • Fix: prevent caching large objects on fill_cache [lferran]

  • Fix: dyncontent vocabularies json serialization [bloodbare]

  • Fix: prevent caching large objects on fill_cache [lferran]

6.1.1 (2021-01-15)

  • Support other languages on FTS at pgcatalog [bloodbare]

  • DB Users storing group on DB due to pickling groups_cache leads to wrong objects [bloodbare]

  • Improve markup (docs/index.md) [svx]

  • Various documentation improvements [svx]

  • Unify wording in dev docs [svx]

6.1.0 (2021-01-11)

  • (Breaking change) Fixing TLS and STARTTLS At configuration starttls was used in case of tls: true. Its needed to change it to starttls: true Now you can configura tls with tls: true or starttls with starttls: true on the server configuration [bloodbare]

  • Better exception on worflow [bloodbare]

6.0.26 (2021-01-10)

  • Bug on Tus Upload with dict fieldname, location is wrong on POST request [bloodbare]

6.0.25 (2021-01-09)

  • Adding config option for max result search value [bloodbare]

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

guillotina-6.3.1-cp38-cp38-macosx_10_15_x86_64.whl (5.9 MB view details)

Uploaded CPython 3.8macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: guillotina-6.3.1.tar.gz
  • Upload date:
  • Size: 6.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5

File hashes

Hashes for guillotina-6.3.1.tar.gz
Algorithm Hash digest
SHA256 39b5a9f9252e271e6a37bb38feeb0dc343a17134adfd12172c002a31b84574fd
MD5 1d2bf3aca29eca63428582fe0948d3ac
BLAKE2b-256 db953d3835894892d52127fba7c7505663f1d7076a7fac29e17dc60b0b15d807

See more details on using hashes here.

File details

Details for the file guillotina-6.3.1-cp38-cp38-macosx_10_15_x86_64.whl.

File metadata

  • Download URL: guillotina-6.3.1-cp38-cp38-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 5.9 MB
  • Tags: CPython 3.8, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5

File hashes

Hashes for guillotina-6.3.1-cp38-cp38-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 4fcb71fca135db02f2cac9b2ddedbfecfa5d8fed178477580bd4acf201e1f503
MD5 87136449acbe8c8fb3c3de9e4bb488dc
BLAKE2b-256 84609f4170569aba503cfce54d99165b2db4e238dad3a99a7636f7b7afb93487

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