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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-rested-0.0.5.tar.gz
.
File metadata
- Download URL: django-rested-0.0.5.tar.gz
- Upload date:
- Size: 19.6 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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07fc294dfa8c0070bdc9b8245a5934fcd2a2b86bcaa8efd32b9c3163973606e2 |
|
MD5 | 6b2c711eda5d19128c57b61947039dbc |
|
BLAKE2b-256 | 480a9126a08f84656b4e106087e89a17ff4455db63ba54d17276fa60f43b4aa9 |