Django API FormsGo to CodeSee Map
Project typeFirst Timer FriendlyCode Framework
- Backend Developers
- Technical Writers
The maintainers of this project have not provided a contribution overview.
The main idea was to create a simple and declarative way to specify the format of expecting requests with the ability
to validate them. Firstly I tried to use Django Forms to
validate my API requests (I use pure Django in my APIs). I have encountered a problem with nesting my requests without
a huge boilerplate. Also, the whole HTML thing was pretty useless in my RESTful APIs.
I wanted to:
- define my requests as object (
- pass the request to my defined object (
form = Form.create_from_request(request)),
- validate my request
- extract data
I wanted to keep:
- friendly declarative Django syntax,
(DeclarativeFieldsMetaclass is beautiful),
- Form fields (In the end, I had to "replace" some of them).
So I have decided to create a simple Python package to cover all my expectations.
If you like nice diagrams you can also check repository
Feel free to open pull requests but please keep in mind this checklist:
- write tests
- write changes to to
- update documentation (if needed)
We use poetry for dependency management. Please write your source code according to the
PEP8 code-style. flake8 is used for
code-style and code-quality checks. Please, be sure that your IDE is following settings according to
We use Django-style tests.
Documentation is places in
docs directory and it's generated using
mkdocs-material. You can build docs calling
poetry run mkdocs build.
Docs will be in
sites directory after build. Documentation is updated after every push to
using GitHub Actions.