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 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.
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
6.0.0a6 (2020-01-13)
Fix bug on swagger with endpoints without explicit security declarations [jordic]
Fix bug on pgcatalog when using it without a request [jordic]
Be able to start database transaction before transaction has started it without causing errors [vangheem]
More detailed information in ValidationErrors [masipcat]
Provide way to configure content types as not globally addable [lferran]
Fix Users and Groups to be addable only on manager folders [lferran]
Fix optimized lookup to work with fields that do not have _type [vangheem]
Prevent creating containers with empty id [lferran]
Fix query param validation [vangheem]
Optimize json deserialization [vangheem]
6.0.0a5 (2020-01-07)
Implemented ‘ErrorsMiddleware’ that catches all undhandled errors [masipcat]
Small changes to the middleware logic [masipcat]
Added IIDChecker adapter [vangheem]
Schema fields default value for required is now False [vangheem]
Denormalized group info when user is added to a group throught users endpoint (issue #806) [jordic]
Add Range header support [vangheem]
Be able to disable supporting range headers in IFileManager.download [vangheem]
Fix validating None values in required fields [vangheem]
Add localroles to @available-roles [jordic]
Add no-install-recommends to Dockerfile (apt options) [svx]
6.0.0a4 (2019-12-23)
Improving ValidationErrors messages [masipcat]
Fix error with requeued async queue tasks
Added valid_id_characters app setting [vangheem]
Better CancelledError handling in resolving a request [vangheem]
Fix duplicate behaviors interfaces in get_all_behavior_interfaces() [qiwn]
Fix adding duplicate behaviors [qiwn]
6.0.0a3 (2019-12-18)
Improved server command and added ‘server_settings’ [masipcat]
Added property ‘status’ to Response [masipcat]
6.0.0a2 (2019-12-17)
Adapt to HTTP1.1 protocol on uvicorn by default [bloodbare]
PatchField: added operation “multi” [masipcat]
@duplicate: added option to reset acl
Make pytest.mark.app_settings work in older pytest versions too [lferran]
@move: destination id conflict should return 409 error, not 412 [inaki]
Explicit loop to execute on tests [bloodbare]
Fix IAbsoluteUrl() returns request query [masipcat]
Added attribute cookies to class Request() [masipcat]
Added uvicorn as a guillotina requirement [masipcat]
Added endpoint @available-roles on container [jordic]
Add configurable expiration for jwt.tokens [jordic]
6.0.0a1 (2019-12-09)
Move tags to a context property to make it indexable on json [bloodbare]
Added async property Request.body_exists [masipcat]
Fixed fixture ‘guillotina’ [masipcat]
Make sure that guillotina uses uvloop on starting if its installed [bloodbare]
Make sure uvicorn uses the same loop as guillotina startup [bloodbare]
Fix tests in ‘test_cache_txn.py’ and ‘test_setup.py’ being skipped [masipcat]
Replaced aiohttp with ASGI (running with uvicorn by default) [dmanchon,masipcat,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
Built Distribution
Hashes for guillotina-6.0.0a6-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db6d559955d6861da89d3cf7729e7c17e35e694ebb9867aaeec4f4cacb266bee |
|
MD5 | 189b1a93bbcac5efffc765ff628cc410 |
|
BLAKE2b-256 | 0b11cfc83deb29e09de202d54d7370958d4abd13ef08f6270117819a0e5254f4 |