Metadata-Version: 2.1
Name: fastapi-cruddy-framework
Version: 0.0.1
Summary: A holistic CRUD/MVC framework for FastAPI, with endpoint policies and relationships
Home-page: https://github.com/mdconaway/fastapi-cruddy-framework
Keywords: fastapi,crud,mvc,orm,ember,sails,json
Author: mdconaway
Author-email: mdconaway@users.noreply.github.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: FastAPI
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: SQLAlchemy (>=1.4.40,<2.0.0)
Requires-Dist: SQLAlchemy-Utils (>=0.38.3,<0.39.0)
Requires-Dist: fastapi[all] (>=0.92.0,<0.93.0)
Requires-Dist: inflect (>=6.0.2,<7.0.0)
Requires-Dist: sqlmodel (>=0.0.8,<0.0.9)
Requires-Dist: uvicorn (>=0.20.0,<0.21.0)
Project-URL: Repository, https://github.com/mdconaway/fastapi-cruddy-framework
Description-Content-Type: text/markdown

<a name="readme-top"></a>

<!-- PROJECT LOGO -->
<div align="center">
  <a href="https://github.com/mdconaway/fastapi-cruddy-framework">
    <img src="logo.png" alt="Logo" width="80" height="80">
  </a>

  <h3 align="center">FastAPI - Cruddy Framework</h3>
</div>

<!-- ABOUT THE PROJECT -->
## About Cruddy Framework

[![Product Name Screen Shot][product-screenshot]](https://github.com/mdconaway/fastapi-cruddy-framework)

Cruddy Framework is a companion library to FastAPI designed to bring the development productivity of Ruby on Rails, Ember.js or Sails.js to the FastAPI ecosystem. Many of the design patterns base themselves on Sails.js "policies," sails-ember-rest automatic CRUD routing, and Ember.js REST-Adapter feature sets. By default, data sent to and from the auto-magic CRUD routes are expected to conform to the Ember.js Rest Envelope / Linked-data specification. This specification is highly readable for front-end developers, allows for an expressive over-the-wire query syntax, and embeds self-describing relationship URL links in each over-the-wire record to help data stores automatically generate requests to fetch or update related records. This library is still in an alpha/beta phase, so use at your own risk. All CRUD actions and relationship types are currently supported, though there may be unexpected bugs. Please report any bugs under "issues."


TODO: All the documentation. See the examples folder for a quick reference of high level setup.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- ABOUT THE PROJECT -->
## Installation

The fastapi-cruddy-framework module can be install using poetry...

```
poetry add fastapi-cruddy-framework
```

Or pip.

```
pip install fastapi-cruddy-framework
```

<!-- LICENSE -->
## License

Distributed under the MIT License. See `LICENSE` for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- MARKDOWN LINKS & IMAGES -->
[product-screenshot]: screenshot.png
