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
5.3.32 (2020-03-06)
Fix integer query param validation [lferran]
5.3.31 (2020-02-28)
Be able to have async schema invariants [vangheem]
5.3.30 (2020-02-24)
Provide better validation for json schema field [vangheem]
5.3.29 (2020-02-21)
Handle error when “None” value provided for behavior data [vangheem]
5.3.28 (2020-02-20)
Handle connection reset errors when downloading files [vangheem]
5.3.27 (2020-02-13)
Add max_ops property to PatchField, BucketListField and BucketDictField [vangheem]
Add clear action to list, dict and annotation patch fields [vangheem]
5.3.26 (2020-02-12)
Improve performance of bucket dict field [vangheem]
5.3.25 (2020-02-11)
Fix storages integration with some asyncpg pool settings [vangheem]
5.3.24 (2020-02-06)
Fix release [vangheem]
5.3.23 (2020-02-06)
Be able to configure max_inactive_connection_lifetime and max_queries of pg pool. [vangheem]
Do not have timeout when closing pg connection. [vangheem]
5.3.22 (2020-02-05)
Fix asyncpg integration with connection leaks on timeout [vangheem]
5.3.21 (2020-02-04)
Validate POST @sharing payload too [lferran]
5.3.20 (2020-02-01)
Be able to customize pg db in test fixtures [vangheem]
5.3.19 (2020-02-01)
fix release [vangheem]
5.3.18 (2020-01-31)
add IAnnotations.async_del type annotation [vangheem]
5.3.17 (2020-01-31)
Add pg db constraint for annotation data [vangheem]
5.3.16 (2020-01-30)
more IRequest type hints [vangheem]
5.3.15 (2020-01-30)
Add json to IRequest for mypy [vangheem]
5.3.14 (2020-01-28)
Fix DummyCache type signature to be the same as base class [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-5.3.32-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be5e406e83c5b1c9e221c1461a48260ab93a7ca2adae39aae90d4f12b0a63772 |
|
MD5 | 5a275599560215c837b5d4cb7d7ad8be |
|
BLAKE2b-256 | dfa454dfad4f66152b60ca5b03fa218543a38278eb690128b6c471de36e41cc2 |