Skip to main content

The easiest way to add a Django and DRF powered API to any project

Project description

Bookrest - The easiest way to add rest API to an arbitrary DB

bookrest image

Bookrest allows you to add an API (and browsable htmls) to arbitrary databases -- well almost arbitrary, the tables must have PKs. The databases do not need to be managed by Django.

Installation and usage

pip install bookrest

Then in your settings.py,

INSTALLED_APPS = [
    # ...
    "rest_framework",
    "bookrest",
]

Add a key to your settings.DATABASES named bookrest, and point it to the DB you want to expose as an API. Keep your default db as is, you can use it for user management and other Django apps.

DATABASES = {
    "default": {
        "ENGINE": "django.db.backends.sqlite3",
        "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
    },
    "bookrest": {
        "ENGINE": "django.db.backends.sqlite3",
        "NAME": os.path.join(BASE_DIR, "data/sample.sqlite3"),
    },
}

Connect your urls to bookrest.urls

urlpatterns = [
    # ...
    path("api/", include("bookrest.urls"))
]

🚀 Boom! You are in business. All your tables will have a full read/write API

bookrest image

Todo

  • Test with Sqlite
  • Publish on Pypi
  • Test with Postgres
  • Test with Mysql
  • Add setting to enable a read only API
  • Enable circleci
  • Silently drop tables with no PKs rather than failing (bad idea??)

Inspired by

This projects was inspired by datasette. I loved datasette, but because DRF has a geat browsable API and Django has powerful introspection capabilities, I wanted to do it in Django+DRF.

Bookrest gets all the power of DRF - browsable API, coreapi, filtering, pagination. Set a REST_FRAMEWORK setting in your settings.py and bookrest will apply it.

Whats with the name?

You can put the bookrest on table, and it makes reading simpler.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bookrest-0.1.4.tar.gz (4.4 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page