asyncio REST API Resource database
Project description
Introduction
============
.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
:target: http://guillotina.readthedocs.io/en/latest/
.. image:: https://travis-ci.org/plone/guillotina.svg?branch=master
:target: https://travis-ci.org/plone/guillotina
.. image:: https://codecov.io/gh/plone/guillotina/branch/master/graph/badge.svg
:target: https://codecov.io/gh/plone/guillotina/branch/master
:alt: Test Coverage
.. image:: https://img.shields.io/pypi/pyversions/guillotina.svg
:target: https://pypi.python.org/pypi/guillotina/
:alt: Python Versions
.. image:: https://img.shields.io/pypi/v/guillotina.svg
:target: https://pypi.python.org/pypi/guillotina
.. image:: https://img.shields.io/pypi/l/guillotina.svg
:target: https://pypi.python.org/pypi/guillotina/
:alt: License
.. image:: https://badges.gitter.im/plone/guillotina.png
:target: https://gitter.im/plone/guillotina
:alt: Chat
Please `read the detailed docs <http://guillotina.readthedocs.io/en/latest/>`_
This is the working project of the next generation Guillotina server based on asyncio.
Dependencies
------------
* python >= 3.6
* 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 easily
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.
Getting started with development
--------------------------------
Using pip::
./bin/pip install requirements.txt
./bin/pip install -e .[test]
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
3.2.18 (2018-11-06)
-------------------
- No longer use `utils.clear_conn_statement_cache` as asyncpg does not properly
clean up prepared statements when using the clear method.
See https://github.com/MagicStack/asyncpg/blob/v0.13.0/asyncpg/connection.py#L1499
The `_maybe_gc_stmt` is never called on the statement so they never get
cleaned from the database. Due to this implementation, with databases under
large enough load, it can cause postgresql to run out of memory.
`utils.clear_conn_statement_cache` is now considered a dangerous API method,
is marked deprecated, implementation is now emptied and will be removed
in the next major version of Guillotina.
As an alternative, use the connection option of `statement_cache_size: 0` or
a very low value for `max_cached_statement_lifetime`.
This case is only noteworthy when running against very large postgresql databases.
In certain cases, PG does a terrible job query planning and pegs CPU.
[vangheem]
3.2.17 (2018-10-20)
-------------------
- Be able to override factory for types
[vangheem]
- Require pycryptodome instead of pycrypto
[vangheem]
3.2.16 (2018-07-16)
-------------------
- Allow patching registry with new shcema fields
3.2.15 (2018-06-20)
-------------------
- Don't fail on read-only pg
3.2.14 (2018-06-14)
-------------------
- Fix nested schema null value deserialization error
[vangheem]
3.2.13 (2018-06-05)
-------------------
- fix deserialization with BucketListField
[vangheem]
3.2.12 (2018-06-04)
-------------------
- Fix behavior's use of zope.interface
[vangheem]
3.2.11 (2018-05-31)
-------------------
- Fix bug in CORS with file upload
[vangheem]
3.2.10 (2018-05-30)
-------------------
- Be able to use and customize GuillotinaUser object without request object
[vangheem]
3.2.9 (2018-05-30)
------------------
- bump
3.2.8 (2018-05-30)
------------------
- Reindex security of group object even if we aren't going to reindex it's children
[vangheem]
- Refactor indexing so we can index security, provide `guillotina.catalog.index.index_object` function
[vangheem]
3.2.7 (2018-05-15)
------------------
- Indexing gathers all data on update instead of
overwriting indexed data
[vangheem]
3.2.6 (2018-05-12)
------------------
- Provide IDatabaseManager.exists for dummy db impelementation
[vangheem]
3.2.5 (2018-05-12)
------------------
- add IDatabaseManager.exists method to be able to check if db exists
[vangheem]
3.2.4 (2018-05-11)
------------------
- Fix dynamic storage urls for cockroach
[vangheem]
- deserialize value before validation on patch fields
[vangheem]
3.2.3 (2018-05-11)
------------------
- Authenticated users have access to view root just like
unauthenticated users
[vangheem]
3.2.2 (2018-05-11)
------------------
- Be able to provide comma separated `permissions` param to `@canido`
[vangheem]
3.2.1 (2018-05-10)
------------------
- Be able to modify file attributes filename, content_type, md5, extension
[vangheem]
3.2.0 (2018-05-10)
------------------
- Provide new IDynamicFields and IDynamicFieldValues behaviors
[vangheem]
- Be able to use PatchField with nested schemas
[vangheem]
- Change Object field to work with dicts and JSON schema
[vangheem]
...
You are seeing a truncated changelog.
You can read the `changelog file <https://github.com/plone/guillotina/blob/master/CHANGELOG.rst>`_
for a complete list.
============
.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
:target: http://guillotina.readthedocs.io/en/latest/
.. image:: https://travis-ci.org/plone/guillotina.svg?branch=master
:target: https://travis-ci.org/plone/guillotina
.. image:: https://codecov.io/gh/plone/guillotina/branch/master/graph/badge.svg
:target: https://codecov.io/gh/plone/guillotina/branch/master
:alt: Test Coverage
.. image:: https://img.shields.io/pypi/pyversions/guillotina.svg
:target: https://pypi.python.org/pypi/guillotina/
:alt: Python Versions
.. image:: https://img.shields.io/pypi/v/guillotina.svg
:target: https://pypi.python.org/pypi/guillotina
.. image:: https://img.shields.io/pypi/l/guillotina.svg
:target: https://pypi.python.org/pypi/guillotina/
:alt: License
.. image:: https://badges.gitter.im/plone/guillotina.png
:target: https://gitter.im/plone/guillotina
:alt: Chat
Please `read the detailed docs <http://guillotina.readthedocs.io/en/latest/>`_
This is the working project of the next generation Guillotina server based on asyncio.
Dependencies
------------
* python >= 3.6
* 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 easily
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.
Getting started with development
--------------------------------
Using pip::
./bin/pip install requirements.txt
./bin/pip install -e .[test]
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
3.2.18 (2018-11-06)
-------------------
- No longer use `utils.clear_conn_statement_cache` as asyncpg does not properly
clean up prepared statements when using the clear method.
See https://github.com/MagicStack/asyncpg/blob/v0.13.0/asyncpg/connection.py#L1499
The `_maybe_gc_stmt` is never called on the statement so they never get
cleaned from the database. Due to this implementation, with databases under
large enough load, it can cause postgresql to run out of memory.
`utils.clear_conn_statement_cache` is now considered a dangerous API method,
is marked deprecated, implementation is now emptied and will be removed
in the next major version of Guillotina.
As an alternative, use the connection option of `statement_cache_size: 0` or
a very low value for `max_cached_statement_lifetime`.
This case is only noteworthy when running against very large postgresql databases.
In certain cases, PG does a terrible job query planning and pegs CPU.
[vangheem]
3.2.17 (2018-10-20)
-------------------
- Be able to override factory for types
[vangheem]
- Require pycryptodome instead of pycrypto
[vangheem]
3.2.16 (2018-07-16)
-------------------
- Allow patching registry with new shcema fields
3.2.15 (2018-06-20)
-------------------
- Don't fail on read-only pg
3.2.14 (2018-06-14)
-------------------
- Fix nested schema null value deserialization error
[vangheem]
3.2.13 (2018-06-05)
-------------------
- fix deserialization with BucketListField
[vangheem]
3.2.12 (2018-06-04)
-------------------
- Fix behavior's use of zope.interface
[vangheem]
3.2.11 (2018-05-31)
-------------------
- Fix bug in CORS with file upload
[vangheem]
3.2.10 (2018-05-30)
-------------------
- Be able to use and customize GuillotinaUser object without request object
[vangheem]
3.2.9 (2018-05-30)
------------------
- bump
3.2.8 (2018-05-30)
------------------
- Reindex security of group object even if we aren't going to reindex it's children
[vangheem]
- Refactor indexing so we can index security, provide `guillotina.catalog.index.index_object` function
[vangheem]
3.2.7 (2018-05-15)
------------------
- Indexing gathers all data on update instead of
overwriting indexed data
[vangheem]
3.2.6 (2018-05-12)
------------------
- Provide IDatabaseManager.exists for dummy db impelementation
[vangheem]
3.2.5 (2018-05-12)
------------------
- add IDatabaseManager.exists method to be able to check if db exists
[vangheem]
3.2.4 (2018-05-11)
------------------
- Fix dynamic storage urls for cockroach
[vangheem]
- deserialize value before validation on patch fields
[vangheem]
3.2.3 (2018-05-11)
------------------
- Authenticated users have access to view root just like
unauthenticated users
[vangheem]
3.2.2 (2018-05-11)
------------------
- Be able to provide comma separated `permissions` param to `@canido`
[vangheem]
3.2.1 (2018-05-10)
------------------
- Be able to modify file attributes filename, content_type, md5, extension
[vangheem]
3.2.0 (2018-05-10)
------------------
- Provide new IDynamicFields and IDynamicFieldValues behaviors
[vangheem]
- Be able to use PatchField with nested schemas
[vangheem]
- Change Object field to work with dicts and JSON schema
[vangheem]
...
You are seeing a truncated changelog.
You can read the `changelog file <https://github.com/plone/guillotina/blob/master/CHANGELOG.rst>`_
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-3.2.18.tar.gz
(1.1 MB
view hashes)
Built Distribution
guillotina-3.2.18-py3-none-any.whl
(366.8 kB
view hashes)
Close
Hashes for guillotina-3.2.18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a221ffa20c27ad630f44107778517419115f2214e1f2e5c3f1b15419f79ed0fb |
|
MD5 | a728f7df4b9b84b96cecde672cbf9cdd |
|
BLAKE2b-256 | e3742a858565388a2b96a9cfb59fee8a0e3cb16bb7afb3cf5cff42f9024cd12b |