![---
databases:
- db:
storage: postgresql
transaction_strategy: resolve
dsn:
scheme: postgres
dbname: guillotina
user: postgres
host: localhost
password: ''
port: 5432
pool_size: 40
read_only: false
host: 127.0.0.1
port: 8080
static:
- favicon.ico: static/favicon.ico
root_user:
password: root
cors:
allow_origin:
- "*"
allow_methods:
- GET
- POST
- DELETE
- HEAD
- PATCH
allow_headers:
- "*"
expose_headers:
- "*"
allow_credentials: true
max_age: 3660
utilities: []](https://image.slidesharecdn.com/guillotina-171026202228/85/Guillotina-The-Asyncio-REST-Resource-API-47-320.jpg)
![from guillotina import configure
from guillotina.content import Item
from guillotina.interfaces import IItem
from guillotina import schema
class ICustomType(IItem):
foo = schema.Text()
@configure.contenttype(
type_name="CustomType",
schema=ICustomType,
behaviors=[
"guillotina.behaviors.dublincore.IDublinCore",
"example.behaviors.ICustomBehavior",
])
class CustomType(Item):
pass](https://image.slidesharecdn.com/guillotina-171026202228/85/Guillotina-The-Asyncio-REST-Resource-API-50-320.jpg)
![from guillotina.traversal import traverse
async def my_task(task_info, root, request):
data = task_info.data
path = data['path']
ob, end_path = await traverse(request, root, path.lstrip('/').split('/'))
assert len(end_path) == 0
from guillotina.component import getUtility
from guillotina_hive.interfaces import IHiveUtility
hive = getUtility(IHiveUtility)
task_info = TaskInfo('my_task', {'foo': 'bar'})
await hive.push_task(task_info)](https://image.slidesharecdn.com/guillotina-171026202228/85/Guillotina-The-Asyncio-REST-Resource-API-56-320.jpg)
Ad
More Related Content
What's hot (20)
Similar to Guillotina: The Asyncio REST Resource API (20)
Ad
Recently uploaded (20)
Ad
Guillotina: The Asyncio REST Resource API
- 1. GUILLOTINA Async REST Resource API to manage millions of objects
- 2. Full Stack Engineer Onna - BCN Connect and search all knowledge inside an enterprise with ML Nathan Van Gheem Plone Software Foundation, FWT Member, UITEAM, SecurityTeam
- 3. CoFounder/CTO Onna - SF/BCN Connect and search all knowledge inside an enterprise with ML Ramon Navarro Bosch Plone Software Foundation & FWT Member
- 4. BACKGROUND
- 5. WEB FRAMEWORKS • Angular/React : Server rendering frameworks are dying • Most sources of data comes from the web/api • Lots of experience on storing, distributing, managing resources
- 6. LOVE We love Plone but wanted to be able to use it in high performant situations with modern web technologies
- 7. Long time ago … 18 years … Zope and ZODB was created object oriented DB and web application server Then 16 years ago … Plone was created layer on top of Z stack to provide CMS Then 7 years ago … Pyramid was created merge pylons + repoze.bfg (zope fork) Then 2 years ago … Plone REST API was created Abstraction layer for creating resources on top of Plone 5 300 python packages Then 1 years ago … plone.server was created Rewrite from scratch of minimum Plone backend with py 3.6 and asyncio
- 9. EVOLUTION The spirit of Plone lives
- 10. LESSONS Taking lessons learned from Plone, simplify and apply to an AsyncIO context
- 11. INSPIRATION Plone/Zope’s hierarchical data model Pyramid’s decorator-based configuration Django’s global application settings ZCA pluggability Plone/Zope’s security model JSON Schema
- 12. FORKS parts of zodb data model plone.behavior zope.security zope.schema zope.component/zope.configuration zope.dublincore zope.i18n zope.lifecycleevent zope.location zope.event
- 13. WHAT IT IS NOT replacement for Plone re-implementation of Plone plone.restapi compatible API guillotina_cms
- 14. FEATURES
- 15. TRANSACTION All operations are managed to be durable and confirmed, conflict resolution policies
- 16. CONSCIENTIOUS WRITER Reduce conflict errors, better performance
- 17. RELATIONAL DATABASES Use the best database systems available PostgreSQL CockroachDB
- 18. TREE Information is organized in trees of objects
- 19. RESOURCES Objects are resources with schema attributes, annotations, OO inheritance and static/ dynamic behaviors. RESOURCE
- 20. JSON SCHEMA/ PYTHON Serialization of python interfaces to JSON Schema and back again
- 21. SECURITY Full definition of permissions / roles / principals with global and local inheritance of permissions on the tree.Allow, Deny, Unset,AllowSingle (no inheritance)
- 22. CRUD DynamicTraversal CRUD HTTP verbs mapping for each content type Custom endpoints for specific operations GET HEAD POST PUTPATCH
- 23. ASYNCIO All based on asyncio for network integrations with external indexers, db, caching, services Based on aioHTTP
- 24. SIMPLE Easy to install, Easy to develop pip install guillotina docker run guillotina/guillotina
- 25. CORS Cors configured globally and enabled by default
- 26. WEBSOCKET Websocket connection to apply operations through frames. Mapping of REST API on aTCP async channel.
- 27. MICRO- SERVICES Perfect for micro services
- 28. TUS Binary resumable file upload
- 29. APPLICATIONS Easily extendable with python packages guillotina_swagger guillotina_elasticsearch guillotina_rediscache guillotina_s3storage guillotina_gcloudstorage guillotina_dbusers guillotina_mailer guillotina_pgcatalog
- 30. EXTENSIBLE Uses zope.interface and based on zope.component utilities and adapters!Yay!
- 31. COOKIE CUTTER Cookie cutter templates for configuration and applications
- 32. QUEUE Operational queue and after response tasks
- 33. EVENT Async event based system to trigger operations in code Async tasks
- 34. REGISTRY Configuration registry for each container
- 35. STATIC FILES AND JS APPS Support for serving JavaScript applications
- 36. MULTI DB Mount multiple DBs Supports: POSTGRESQL COCKROACH
- 37. FILE CLOUD Support for S3/GCloud storage. Database blob storage otherwise
- 41. CONTAINERS Docker / K8s / Nomad out the box
- 42. EXPLICIT PY All configuration is defined on the code using decorators @configure.service()
- 43. guillotina(x) = argmin Zope/Plone(x) * zope.interface still used
- 45. • Only >= Python 3.6 • Designed to host millions of objects • Memory optimizations • Apply operations to contained objects in async • Authentication & authorization extensions • Reusable UI JS components from Plone (Widgets/SPA)
- 46. TRY IT !
- 47. --- databases: - db: storage: postgresql transaction_strategy: resolve dsn: scheme: postgres dbname: guillotina user: postgres host: localhost password: '' port: 5432 pool_size: 40 read_only: false host: 127.0.0.1 port: 8080 static: - favicon.ico: static/favicon.ico root_user: password: root cors: allow_origin: - "*" allow_methods: - GET - POST - DELETE - HEAD - PATCH allow_headers: - "*" expose_headers: - "*" allow_credentials: true max_age: 3660 utilities: []
- 48. docker run -p 5432:5432 -d postgres psql -h localhost -U postgres << EOF CREATE DATABASE guillotina; EOF pip install guillotina guillotina -c config.json curl -X GET http://localhost:8080 curl -u root:root http://localhost:8080 curl -X POST -u root:root -H "Content-Type: application/json" -d '{"@type":"Container","id":"mycontainer","title":"My Lovely Container"}' http://localhost:8080/db/ | jq . curl -X POST -u root:root -H "Content-Type: application/json" -d '{"@type":"Folder","id":"myfolder"}' http://localhost:8080/db/mycontainer | jq . curl -X POST -u root:root -H "Content-Type: application/json" -d '{"@type":"Folder"}' http://localhost:8080/db/mycontainer | jq . curl -X POST -u root:root -H "Content-Type: application/json" -d '{"@type":"Item","id":"myitem"}' http://localhost:8080/db/mycontainer/myfolder | jq . curl -X PATCH -u root:root -H "Content-Type: application/json" -d '{"title": "My new title"}' http://localhost:8080/db/mycontainer/myfolder/myitem | jq . curl -X GET -u root:root -H "Content-Type: application/json" -d '{"title": "My new title"}' http://localhost:8080/db/mycontainer/myfolder/myitem | jq . curl -X DELETE -u root:root -H "Content-Type: application/json" http://localhost:8080/db/mycontainer | jq .
- 49. DATA MODEL Resource & Container Interface Schema fields Static Behaviors Dynamic Behaviors
- 50. from guillotina import configure from guillotina.content import Item from guillotina.interfaces import IItem from guillotina import schema class ICustomType(IItem): foo = schema.Text() @configure.contenttype( type_name="CustomType", schema=ICustomType, behaviors=[ "guillotina.behaviors.dublincore.IDublinCore", "example.behaviors.ICustomBehavior", ]) class CustomType(Item): pass
- 51. @configure.subscriber(for_=(ICustomType, IObjectAddedEvent)) async def created_userfolder(obj, evnt): ... @configure.service( context=ICustomType, name='@myEndpoint', method='GET', permission='guillotina.AccessContent') async def my_service(context, request): ...
- 52. DATA SCIENCE
- 53. “Organizing data is where we spend more time and its boring.” Data Scientist Sysadmin / Engineers
- 54. Tables / CSV Docs / Unstructured data NOSQLSQL
- 55. WIP : DISTRIBUTED HIVE Execute an operation to all objects in distributed execution Based on etcd Dynamic workers that are going to compute a task No aggregation callback Batch mass modification of the model guillotina_hive (thanks @vangheezy)
- 56. from guillotina.traversal import traverse async def my_task(task_info, root, request): data = task_info.data path = data['path'] ob, end_path = await traverse(request, root, path.lstrip('/').split('/')) assert len(end_path) == 0 from guillotina.component import getUtility from guillotina_hive.interfaces import IHiveUtility hive = getUtility(IHiveUtility) task_info = TaskInfo('my_task', {'foo': 'bar'}) await hive.push_task(task_info)
- 57. Try it, create issues, contribute
- 58. Go to the “Introduction to AsyncIO” talk!
- 59. PREGUNTES ? GRÀCIES ! [email protected] [email protected] CORE : https://github.com/plone/guillotina DOCS : http://guillotina.readthedocs.io/en/latest/ DOCKER: https://hub.docker.com/r/guillotina/guillotina/ MODULES : https://github.com/guillotinaweb ONNA: https://github.com/onna