{"id":13936427,"url":"https://github.com/tbone-framework/TBone","last_synced_at":"2025-07-19T22:30:27.091Z","repository":{"id":52129066,"uuid":"101471583","full_name":"tbone-framework/TBone","owner":"tbone-framework","description":"Full duplex RESTful API for your asyncio web apps","archived":true,"fork":false,"pushed_at":"2021-05-07T02:25:01.000Z","size":623,"stargazers_count":36,"open_issues_count":9,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-27T23:55:18.254Z","etag":null,"topics":["aiohttp","async-await","asyncio","mongodb","nonblocking","odm","python","python3","rest","rest-api","restful","restful-api","restful-webservices","sanic","tbone","websockets"],"latest_commit_sha":null,"homepage":"http://tbone.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tbone-framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-26T07:52:56.000Z","updated_at":"2024-01-13T23:57:09.000Z","dependencies_parsed_at":"2022-09-26T17:40:57.993Z","dependency_job_id":null,"html_url":"https://github.com/tbone-framework/TBone","commit_stats":null,"previous_names":["475cumulus/tbone"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbone-framework%2FTBone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbone-framework%2FTBone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbone-framework%2FTBone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbone-framework%2FTBone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tbone-framework","download_url":"https://codeload.github.com/tbone-framework/TBone/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226686718,"owners_count":17666928,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aiohttp","async-await","asyncio","mongodb","nonblocking","odm","python","python3","rest","rest-api","restful","restful-api","restful-webservices","sanic","tbone","websockets"],"created_at":"2024-08-07T23:02:39.804Z","updated_at":"2024-11-27T04:31:01.515Z","avatar_url":"https://github.com/tbone-framework.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# TBone\n\n![logo](https://user-images.githubusercontent.com/3540587/31142318-9ee5dfa0-a882-11e7-998e-064147470615.png)\n\n\n[![Build Status](https://travis-ci.org/475Cumulus/TBone.svg?branch=master)](https://travis-ci.org/475Cumulus/TBone)\n[![PyPI version](https://badge.fury.io/py/tbone.svg)](https://badge.fury.io/py/tbone)\n[![Python](https://img.shields.io/pypi/pyversions/gain.svg)](https://pypi.python.org/pypi/gain/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n[![Waffle.io - Issues in progress](https://badge.waffle.io/475Cumulus/TBone.svg?label=in%20progress\u0026title=In%20Progress)](http://waffle.io/475Cumulus/TBone)\n[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/tbone-framework/Lobby)\n\nTBone makes it easy to develop full-duplex RESTful APIs on top of your `asyncio` web application or webservice.\nIt uses a nonblocking asynchronous web server and provides the neccesary infrastructure to build asynchronous web apps and services.\nTBone is web-server agnostic and can be added on top of your `Sanic` or `Aiohttp` app.\n\n\nTBone is comprised of 4 major modules:\n\n1. Data Structure - an ODM-like modeling mechanism for schema declaration, data validation and serialization\n2. Data Persistency - Persistency mixin classes for document stores with a full implementation over MongoDB\n3. Resources - Mechanism for creating full-duplex RESTful APIs over `HTTP` and `Websockets`\n4. Dispatch - Classes for managing internal and external events.\n\nCombining the usage of these 4 modules makes it extremely easy to build full-duplex RESTful APIs on top of your MongoDB datastore.\n\n\n## Disclaimer\n\nTBone is currently in Alpha stage. It may still have some bugs in the code, and some typos in the documentation.\nThe APIs may change before an official release is made.\n\n\n## Example\n\nThe following example demonstrates the creation of a model schema and the corresponding RESTful resource\n\n```python\nclass Book(Model, MongoCollectionMixin):\n    _id = ObjecIdField(primary_key=True)\n    title = StringField(required=True)\n    author = StringField(required=True)\n    publication_date = DateTimeField()\n\n\nclass BookResource(AioHttpResource, MongoResource):\n    class Meta:\n        object_class = Book\n```\n\n## Nonblocking\n\nTBone was designed to develop asynchorous web applications and web services. The entire infrastructure was built around `coroutines`.\nTBone utilizes only asynchronous 3rd party components to make sure that your app is truly nonblocking.\n\n## Requirements\n\nTBone uses the async/await syntax and is limited to Python version 3.5 and up.\n\nFurthermore, TBone has some very few basic requirements.\nHowever, depending on its usage requires additional packages may be required.\n\n## Documentation\n\n[Documentation can be found here](https://tbone.readthedocs.io)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftbone-framework%2FTBone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftbone-framework%2FTBone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftbone-framework%2FTBone/lists"}