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 easily with docker.
Download and start the docker container by running:
make run-postgres
Run the server
To run the server:
g
Then…
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.0.2 (2019-08-30)
Fix json schema validation [vangheem]
Fix memory cache to be able to calc size properly [vangheem]
Better redis pubsub error handling [vangheem]
5.0.1 (2019-08-30)
Be not log verbose when pubsub utility task is cancelled [vangheem]
5.0.0 (2019-08-30)
Be able to configure cache to not push pickles with invalidation data [vangheem]
Fix transaction handling to always get current active transaction, throw exception when transaction is closed and be able to refresh objects. [vangheem]
More normalization of execute module with task_vars/request objects [vangheem]
Allow committing objects that were created with different transaction [vangheem]
Fix async utils to work correctly with transactions and context vars [vangheem]
Be able to have None default field values [vangheem]
5.0.0a16 (2019-08-26)
Throw exception when saving object to closed transaction [vangheem]
Fix cache key for SQLStatements cache. This was causing vacuuming on multi-db environments to not work since the vacuuming object was shared between dbs on guillotina_dynamictablestorage. [vangheem]
Implement more optimized way to vacuum objects which dramatically improves handling of deleting very large object trees [vangheem]
Fix LightweightConnection pg class to close active cursors when connection done [vangheem]
Swagger doc for search endpoint [karannaoh]
Fix modification_date not indexed when an object is patched [masipcat]
Move to black code formatter [vangheem]
Fix field.validate() crashes when providing invalid schema (for field of type Object) [masipcat]
Upgrade to Swagger 3/Open API 3 [karannaoh]
Implement json schema validation [karannaoh]
5.0.0a15 (2019-08-02)
Dict schema serialization needs properties to be valid JSON Schema [bloodbare]
Fix potential bug when working with multiple databases/transaction managers [vangheem]
New guillotina.fields.BucketDictField [vangheem]
New @fieldvalue/{field name or dotted behavior + field name} endpoint [vangheem]
5.0.0a14 (2019-07-30)
Leaking txn on reindex on pg [bloodbare]
5.0.0a13 (2019-07-29)
Run default factory on attributes on behaviors [bloodbare]
Allow to get full object serialization on GET operation [bloodbare]
Only register object for writing if base object changed. Otherwise, changes to behavior data was also causing writes to the object it was associated with [vangheem]
Add x-virtualhost-path header support for url generation [vangheem]
5.0.0a12 (2019-07-26)
Make Tuple type work with patch field [vangheem]
Make IDublinCore.tags a patch field [vangheem]
Add appendunique and extendunique to patch field operations [vangheem]
Fix exhausted retries conflict error response [vangheem]
Make sure field name of patch field is set before using [vangheem]
Improve request memory usage [vangheem]
Fix: just skip indexing attributes from schemas that object does not adapt to [lferran]
5.0.0a11 (2019-07-22)
Allow to receive a fullobject serialization on search [bloodbare]
Allow to reindex on PG catalog implementation [bloodbare]
Read only txn can be reused without changing read only param [bloodbare]
Merge CORS headers [qiwn]
Fix redis pubsub potential cpu bound deadlock [vangheem]
Make sure that channel is configured on cache pubsub [bloodbare]
Handle cancelled error on cleanup [vangheem]
Define TTL on cache set [bloodbare]
Logging async util exception [bloodbare]
Documentation improvements [vangheem]
Cache JSONField schema validator object [vangheem]
JSONField works with dict instead of requiring str(which is then converted to dict anyways) [vangheem]
5.0.0a10 (2019-06-27)
Adding store_json property on db configuration so we can disable json storage for each db. [bloodbare]
5.0.0a9 (2019-06-27)
Move guillotina_mailer to guillotina.contrib.mailer [bloodbare]
Be able to customize the object reader function with the object_reader setting [vangheem]
Fix indexing data potentially missing updated content when fields for accessor is not specified [vangheem]
- Executioner:
providing pagination support in navigation (1.2.0)
supporting token authentication from login form (1.3.0)
using @search endpoint to navigate in container items
A few more python antipattern fixes [lferran]
5.0.0a8 (2019-06-23)
Aggregations in PG JSONb [bloodbare]
5.0.0a7 (2019-06-22)
Change guillotina.files.utils.generate_key to not accept a request parameter. It was used to get the container id which is now a context var. [vangheem]
Add IExternalFileStorageManager interface to be able to designate a file storage that store a file into an external database. This enables you to automatically leverage the redis data manager.
Add cloud_datamanager setting. Allows you to select between db`(default) and `redis`(if `guillotina.contrib.redis is used) to not write to db to maintain state. The redis option is only usable for gcloud and s3 adapters.
5.0.0a6 (2019-06-22)
Cache password checked decisions to fix basic auth support [vangheem]
Make sure you can import contrib packages without automatically activating them [vangheem]
5.0.0a5 (2019-06-22)
Adding rediscache and pubsub logic. Now you can have memory cache, network cache with invalidation and pubsub service. guillotina_rediscache is not necessary any more. [bloodbare]
deprecate __local__properties__. ContextProperty works on it’s own now [vangheem]
Add argon2 pw hashing [vangheem]
Completely remove support for utilities configuration. Use load_utilities. [vangheem]
5.0.0a4 (2019-06-21)
Fix path__startswith query [vangheem]
5.0.0a3 (2019-06-21)
Add guillotina.contrib.swagger
5.0.0a2 (2019-06-19)
Missing mypy requirement
Fix catalog interface
Fix catalog not working with db schemas
Update intro docs
5.0.0a1 (2019-06-19)
Fix events antipattern [lferran]
Rename utils.get_object_by_oid to utils.get_object_by_uid
Emit events for registry configuration changes
Default catalog interface removes the following methods: get_by_uuid, get_by_type, get_by_path, get_folder_contents. Keep interfaces simple, use search/query.
Allow modifying app settings from pytest marks [lferran]
No longer setup fake request with login for base command
Moved ISecurityPolicy.cached_principals to module level function guillotina.security.policy.cached_principals
Moved ISecurityPolicy.cached_roles to module level function guillotina.security.policy.cached_roles
utils.get_authenticated_user_id no longer accepts request param
utils.get_authenticated_user no longer accepts request param
Removed guillotina.exceptions.NoInteraction
Removed guillotina.interfaces.IInteraction
auth_user_identifiers no longer accept IRequest in the constructor. Use utils.get_current_request
auth_user_identifiers no longer accept IRequest in constructor. Use utils.get_current_request
Remove IInteraction. Use guillotina.utils.get_security_policy()
Remove Request._db_write_enabled, Transaction now has read_only property
Remove Request._db_id, Use guillotina.task_vars.db.get().id
Remove Request.container_settings, Use guillotina.utils.get_registry
Remove Request._container_id, use guillotina.task_vars.container.get().id
Remove Request.container, Use guillotina.task_vars.container.get()
Remove Request.add_future. Use guillotina.utils.execute.add_future
Add guillotina.utils.get_current_container
Rename request_indexer setting to indexer
Rename guillotina.catalog.index.RequestIndexer to guillotina.catalog.index.Indexer
Rename IWriter.parent_id to IWriter.parent_uid
Rename guillotina.db.oid to guillotina.db.uid
Rename oid_generate setting to uid_generator
Rename BaseObject._p_register -> BaseObject.register
Rename BaseObject._p_serial -> BaseObject.__serial__
Rename BaseObject._p_oid -> BaseObject.__uuid__
Rename BaseObject._p_jar -> BaseObject.__txn__
separate transaction from request object
rename guillotina.transactions.managed_transaction to guillotina.transactions.transaction…
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.
Source Distribution
Built Distribution
Hashes for guillotina-5.0.2-cp37-cp37m-macosx_10_14_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e448d961690916847a364fe8c506c580789c843032400605419b609157d7473b |
|
| MD5 | 52281145d1e7cbf4e16fa539fd36936b |
|
| BLAKE2b-256 | c61f34b1cad11fac09f4e5e292750876c5244a3d34c133ccbadd55fb578a5715 |
