SAFRS: Python OpenAPI & JSON:API Framework
==========================================
Please check the `GitHub Readme <https://github.com/thomaxxl/safrs>`__ for documentation.
Overview
--------
SAFRS is an acronym for **S**\ ql\ **A**\ lchemy **F**\ lask-\ **R**\ estful **S**\ wagger. The purpose of this framework is to help python developers create a self-documenting JSON API for sqlalchemy database objects and relationships. These objects can be serialized to JSON and can be created, retrieved, updated and deleted through the JSON API.
Optionally, custom resource object methods can be exposed and invoked using JSON.
Class and method descriptions and examples can be provided in yaml syntax in the code comments. The description is parsed and shown in the swagger web interface.
The result is an easy-to-use `swagger/OpenAPI <https://swagger.io/>`_ and `JSON:API <jsonapi.org>`_ compliant API specification.
Installation
------------
SAFRS can be installed as a `pip package <https://pypi.python.org/pypi/safrs/>`_ or by downloading the latest version from github, for example:
.. code-block:: bash
git clone https://github.com/thomaxxl/safrs
cd safrs
pip3 install -r requirements.txt --user
python3 setup.py install --user
The examples can then be started with
.. code-block::
python3 examples/demo_relationship.py "your-interface-ip"
Raw data
{
"_id": null,
"home_page": "https://github.com/thomaxxl/safrs",
"name": "safrs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6, !=3.0.*, !=3.1.*, !=3.2.*, <4",
"maintainer_email": "",
"keywords": "SqlAlchemy,Flask,REST,Swagger,JsonAPI,OpenAPI",
"author": "Thomas Pollet",
"author_email": "thomas.pollet@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b4/5e/9d6a80d8c0e657e310d59a43e46e572300e329ba02e76cce266de2362da8/safrs-3.1.1.tar.gz",
"platform": null,
"description": "SAFRS: Python OpenAPI & JSON:API Framework\n==========================================\n\nPlease check the `GitHub Readme <https://github.com/thomaxxl/safrs>`__ for documentation.\n\nOverview\n--------\n\nSAFRS is an acronym for **S**\\ ql\\ **A**\\ lchemy **F**\\ lask-\\ **R**\\ estful **S**\\ wagger. The purpose of this framework is to help python developers create a self-documenting JSON API for sqlalchemy database objects and relationships. These objects can be serialized to JSON and can be created, retrieved, updated and deleted through the JSON API.\nOptionally, custom resource object methods can be exposed and invoked using JSON.\nClass and method descriptions and examples can be provided in yaml syntax in the code comments. The description is parsed and shown in the swagger web interface.\n\nThe result is an easy-to-use `swagger/OpenAPI <https://swagger.io/>`_ and `JSON:API <jsonapi.org>`_ compliant API specification.\n\nInstallation\n------------\n\nSAFRS can be installed as a `pip package <https://pypi.python.org/pypi/safrs/>`_ or by downloading the latest version from github, for example:\n\n.. code-block:: bash\n\n git clone https://github.com/thomaxxl/safrs\n cd safrs\n pip3 install -r requirements.txt --user\n python3 setup.py install --user\n\n\nThe examples can then be started with\n\n.. code-block::\n\n python3 examples/demo_relationship.py \"your-interface-ip\"\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "safrs : SqlAlchemy Flask-Restful Swagger2",
"version": "3.1.1",
"project_urls": {
"Download": "https://github.com/thomaxxl/safrs/archive/3.1.1.tar.gz",
"Homepage": "https://github.com/thomaxxl/safrs"
},
"split_keywords": [
"sqlalchemy",
"flask",
"rest",
"swagger",
"jsonapi",
"openapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dde1b9ed654da2ce95e6020ff67a9025ff81c8bdd5783ff786aaabc914496673",
"md5": "3cecde8305e678a7b3d9d7d23f42a75d",
"sha256": "f0d2c198e4b3ba0975b8e2639d153fe99ddac2a68ee1bf48bde62e66f482d739"
},
"downloads": -1,
"filename": "safrs-3.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3cecde8305e678a7b3d9d7d23f42a75d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6, !=3.0.*, !=3.1.*, !=3.2.*, <4",
"size": 75350,
"upload_time": "2023-07-15T19:38:04",
"upload_time_iso_8601": "2023-07-15T19:38:04.127907Z",
"url": "https://files.pythonhosted.org/packages/dd/e1/b9ed654da2ce95e6020ff67a9025ff81c8bdd5783ff786aaabc914496673/safrs-3.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b45e9d6a80d8c0e657e310d59a43e46e572300e329ba02e76cce266de2362da8",
"md5": "38407cef6ba7b4c610ebcd4dfd8904f6",
"sha256": "3a6305ff4610e292973edd10f50defda53a8f5b5c2953a06a16fdbe8340c8b3d"
},
"downloads": -1,
"filename": "safrs-3.1.1.tar.gz",
"has_sig": false,
"md5_digest": "38407cef6ba7b4c610ebcd4dfd8904f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6, !=3.0.*, !=3.1.*, !=3.2.*, <4",
"size": 73758,
"upload_time": "2023-07-15T19:38:06",
"upload_time_iso_8601": "2023-07-15T19:38:06.199529Z",
"url": "https://files.pythonhosted.org/packages/b4/5e/9d6a80d8c0e657e310d59a43e46e572300e329ba02e76cce266de2362da8/safrs-3.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-15 19:38:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thomaxxl",
"github_project": "safrs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "safrs"
}
JSON
