Skip to main content

Make creating rest APIs in Django simple.

Project description

Rested

Make creating rest APIs in Django simple.

Rested is a simple batteries included tool to make building rest API's using Django fast and easy.

Usage

Quick Start

Command Line

The command line interface has commands to start a dev server, run development shell, run tests, run Django management commands, create an empty example project, and run a Celery background task worker.

Validation

To validate a field you must start with a root validator: to, am, accepts, or optional. All root validators check that a field is defined before proceeding with the exception of optional which will immediately accept if the field is undefined on the json object.

Contributing

Lauching Dev Stack

Use docker compose to launch development stack.

Running Tests

To run tests:
pytest

To run a specific test suite:
pytest -s -k test_rested

To run a specific test in a suite:
pytest -s -k "test_validate and test_check"

To run tests with auto reload:
env PYTHONPATH="/rested/tests" ptw

To run tests with auto reload and specific test:
env PYTHONPATH="/rested/tests" ptw --runner "pytest -s -k test_rested"

To see print statements of passing tests use the -s flag

Note: Errors like this might have a root exception with more detail and may mean you are missing migrations: psycopg2.errors.InvalidCursorName

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

django-rested-0.0.6.tar.gz (19.8 kB view details)

Uploaded Source

File details

Details for the file django-rested-0.0.6.tar.gz.

File metadata

  • Download URL: django-rested-0.0.6.tar.gz
  • Upload date:
  • Size: 19.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.9

File hashes

Hashes for django-rested-0.0.6.tar.gz
Algorithm Hash digest
SHA256 c9e64ed18e0f5fa80ecd5a40794d587b5f90e0eb23a575973dda79e783692c54
MD5 f25648c245a36210bc90144a249e2188
BLAKE2b-256 445f44c23e2b3efcda5de4e3f611299869fcfe957681f437411801fe935c8e29

See more details on using hashes here.

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