https://github.com/tbone-framework/TBone

Full duplex RESTful API for your asyncio web apps
https://github.com/tbone-framework/TBone

aiohttp async-await asyncio mongodb nonblocking odm python python3 rest rest-api restful restful-api restful-webservices sanic tbone websockets

Last synced: about 2 months ago
JSON representation

Full duplex RESTful API for your asyncio web apps

• Host: GitHub
• URL: https://github.com/tbone-framework/TBone
• Owner: tbone-framework
• License: mit
• Archived: true
• Created: 2017-08-26T07:52:56.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-05-07T02:25:01.000Z (over 3 years ago)
• Last Synced: 2024-04-27T23:55:18.254Z (9 months ago)
• Topics: aiohttp, async-await, asyncio, mongodb, nonblocking, odm, python, python3, rest, rest-api, restful, restful-api, restful-webservices, sanic, tbone, websockets
• Language: Python
• Homepage: http://tbone.io
• Size: 608 KB
• Stars: 36
• Watchers: 2
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# TBone

![logo](https://user-images.githubusercontent.com/3540587/31142318-9ee5dfa0-a882-11e7-998e-064147470615.png)

[![Build Status](https://travis-ci.org/475Cumulus/TBone.svg?branch=master)](https://travis-ci.org/475Cumulus/TBone)

[![PyPI version](https://badge.fury.io/py/tbone.svg)](https://badge.fury.io/py/tbone)

[![Python](https://img.shields.io/pypi/pyversions/gain.svg)](https://pypi.python.org/pypi/gain/)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![Waffle.io - Issues in progress](https://badge.waffle.io/475Cumulus/TBone.svg?label=in%20progress&title=In%20Progress)](http://waffle.io/475Cumulus/TBone)

[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/tbone-framework/Lobby)

TBone makes it easy to develop full-duplex RESTful APIs on top of your `asyncio` web application or webservice.

It uses a nonblocking asynchronous web server and provides the neccesary infrastructure to build asynchronous web apps and services.

TBone is web-server agnostic and can be added on top of your `Sanic` or `Aiohttp` app.

TBone is comprised of 4 major modules:

1. Data Structure - an ODM-like modeling mechanism for schema declaration, data validation and serialization

2. Data Persistency - Persistency mixin classes for document stores with a full implementation over MongoDB

3. Resources - Mechanism for creating full-duplex RESTful APIs over `HTTP` and `Websockets`

4. Dispatch - Classes for managing internal and external events.

Combining the usage of these 4 modules makes it extremely easy to build full-duplex RESTful APIs on top of your MongoDB datastore.

## Disclaimer

TBone is currently in Alpha stage. It may still have some bugs in the code, and some typos in the documentation.

The APIs may change before an official release is made.

## Example

The following example demonstrates the creation of a model schema and the corresponding RESTful resource

```python

class Book(Model, MongoCollectionMixin):

    _id = ObjecIdField(primary_key=True)

    title = StringField(required=True)

    author = StringField(required=True)

    publication_date = DateTimeField()

class BookResource(AioHttpResource, MongoResource):

    class Meta:

        object_class = Book

```

## Nonblocking

TBone was designed to develop asynchorous web applications and web services. The entire infrastructure was built around `coroutines`.

TBone utilizes only asynchronous 3rd party components to make sure that your app is truly nonblocking.

## Requirements

TBone uses the async/await syntax and is limited to Python version 3.5 and up.

Furthermore, TBone has some very few basic requirements.

However, depending on its usage requires additional packages may be required.

## Documentation

[Documentation can be found here](https://tbone.readthedocs.io)