https://github.com/russellluo/resource

A Python library concentrated on the Resource layer of RESTful APIs.
https://github.com/russellluo/resource

Last synced: over 1 year ago
JSON representation

A Python library concentrated on the Resource layer of RESTful APIs.

• Host: GitHub
• URL: https://github.com/russellluo/resource
• Owner: RussellLuo
• Created: 2014-09-22T04:55:54.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-04-15T22:38:29.000Z (over 3 years ago)
• Last Synced: 2025-03-22T14:41:29.926Z (over 1 year ago)
• Language: Python
• Homepage:
• Size: 172 KB
• Stars: 18
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
**NOTE:**

This library will not be actively maintained any further. You probably want to see the [RESTArt][1] library (still in development), which is a replacement with better intentions.

---

Resource

========

A Python library concentrated on the Resource layer of RESTful APIs.

Philosophy

----------

You have data somewhere:

1. physical data stored in databases like MongoDB (NoSQL) or MySQL (RDBMS)

2. virtual data existing in applications (e.g. data in business logic)

and you want to expose it to your users through a RESTful Web API. `Resource` is a convenient library that allows you to do so.

`Resource` is database agnostic and web framework agnostic, which means you should/can choose databases (MongoDB, MySQL, etc.) and web frameworks (Flask, Django, etc.) yourself.

Installation

------------

Install `Resource` with `pip`:

    $ pip install Resource

Install development version from `GitHub`:

    $ git clone https://github.com/RussellLuo/resource.git

    $ cd resource

    $ python setup.py install

Features

--------

+ Full range of CRUD operations

+ JSON all the time

+ Easy and Extensible Data Validation

+ Intelligent and Extensible Serializer

+ Filtering

+ Pagination

+ Sorting

+ Fields Selection

+ Authentication

+ Sub Resources

+ Cross Origin

+ Support MongoDB

+ Support RDBMS

+ Support Flask

+ Support Django

Documentation

-------------

Complete documentation is available [here][2].

License

-------

[MIT][3]

[1]: https://github.com/RussellLuo/restart

[2]: https://github.com/RussellLuo/resource/blob/master/docs/index.md

[3]: http://opensource.org/licenses/MIT