Package: ripozo
Ripozo is a tool for building RESTful/HATEOAS/Hypermedia apis.  It provides
strong, simple, and fully qualified linking between resources, the ability to expose
available actions and necessary parameters on a resource, and exposing
multiple REST protocols (i.e. SIREN and HAL).  Finally, ripozo is highly extensible.
It is able to integrate with any web framework or database and you can easily roll out
your own REST protocols.Why use ripozo?Strong support for inter-resource linking (HATEOAS/Hypermedia)Flexible (can be used with any web framework, database, or response protocol)Fast development (especially when using the extensions, such as flask-ripozo or django-ripozo)Ability to expose actions on resource from the web api (self-discoverability)ExamplesYou’ll need to create a dispatcher using one of the dispatchers included
in the framework extensions.  You can find a list of framework extensions inThe ripozo ecosystemsection.  If it’s not there you can always roll out your own.Minimalfromripozoimportapimethod,adapters,ResourceBase# import the dispatcher class for your preferred webframeworkclassMyResource(ResourceBase):@apimethod(methods=['GET'])defsay_hello(cls,request):returncls(properties=dict(hello='world'))# initialize the dispatcher for your framework# e.g. dispatcher = FlaskDispatcher(app)dispatcher.register_adapters(adapters.SirenAdapter,adapters.HalAdapter)dispatcher.register_resources(MyResource)And just like that, you have an api that can return either Siren or Hal
formatted responses.  Pretty easy, right?Full CRUD+LOn the other hand, if you wanted a full CRUD+L (Create, Retrieve, Update, Delete, and List),
you could use one of the manager extensions (django-ripozo,ripozo-sqlalchemy, andripozo-cassandraall
include ready to use base managers). There are slight differences
on creating Manager classes and instances in the different extensions but at a core they all follow this
format.fromripozoimportrestmixinsfromfake_ripozo_extensionimportManagerfrommyapp.modelsimportMyModel# An ORM model for example a sqlalchemy or Django model.classMyManager(Manager):fields=('id','field1','field2',)model=MyModelclassMyResource(restmixins.CRUDL):manager=MyManager()pks=('id',)# Create your dispatcher and register the resource...It is important to note that there are restmixins for each of
the individual CRUD+L (i.e. restmixins.Create, restmixins.Retrieve, etc.)
actions that can be mixed and matched to your pleasure.LinksThe coolest part of ripozo is the ability to easily create fully qualified links between
resources.fromripozoimportrestmixins,RelationshipclassMyResource(restmixins.CRUDL):manager=MyManager()pks=('id',)_relationships=[Relationship('related',relation='RelatedResource')]classRelatedResource(restmixins.CRUDL)manager=RelatedManager()pks=('id',)Now whenever you request MyResource you’ll get a link pointing to
the related resource.Documentationripozo documentationThe ripozo ecosystemCurrently, ripozo has integrations with Django, Flask, SQLAlchemy,
and Cassandra (via cqlengine).  The documentation links are provided
below.FrameworksDatabasesflask-ripozoripozo-sqlalchemydjango-ripozoripozo-cassandraBuilt an extension for ripozo? Let us know and we’ll add it in here!Helpful linksflask-ripozo/ripozo-sqlalchemy tutorialdjango-ripozo tutorialInstallationpipinstallripozoVersioningPrior to version 1.0.0 ripozo versioning followssentimental
versioning.   Releases after 1.0.0 follow
a standardmajor.minor.patchstyle.patch: forwards and backwards compatibleminor: backwards compatiblemajor: No guaranteesContributingWant to help out? We’d love it! Github will be the hub of development for ripozo.
If you have any issues, comments, or complaints post them there.  Additionally, we
are definitely accepting pull requests (hint: we almost always love more tests and
documentation).  We do have just a few requests:Every method, function, and class should have a thorough docstringThere should be at least one unit test for each function and methodKeep your pull requests to one issue. (Preferably open an issue on github first for record keeping)Behind the nameRipozo translates to  “rest” in Esperanto.  Esperanto was designed to be a universal language.  Anyone,
no matter their native language, can learn and use it easily.  Similarly, ripozo is intended
to be a universal ReST framework.  No matter your preference of database, web framework, or
protocol, ripozo makes it easy to build.