asyncio REST API Resource database
Project description
Introduction
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 guillotinaRun 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-postgresRun the server
To run the server
gThen…
curl http://localhost:8080Or, 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.
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 installRun tests
We’re using pytest
./bin/pytest guillotinaand for test coverage
./bin/pytest --cov=guillotina guillotina/With file watcher…
./bin/ptw guillotina --runner=./bin/py.testTo run tests with cockroach db
USE_COCKROACH=true ./bin/pytest guillotinaDefault
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.6Then, 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.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]
6.0.24 (2021-01-07)
(Breaking change) Fix download file name to query parameter so dictionary file field downloads with filename. API with filename on query path needs to change to filename query param [bloodbare]
6.0.23 (2021-01-05)
Dynamic content via config.yaml [bloodbare]
Fix file not deleted in IMultiAttachments dict [masipcat]
Keyword not pg catalog search and aggregation endpoint [bloodbare]
6.0.22 (2020-12-23)
Fixing addable-types, filtering not global addable types. [bloodbare]
PyJwt > 2.0 breaks contract on decoding a JWT. Pinning to 1.6.0 [bloodbare]
6.0.21 (2020-12-22)
Adding typing_extensions as dependency [bloodbare]
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]
…
You are seeing a truncated changelog.
You can read the changelog file for a complete list.
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.
