Welcome to Django-Model-To-Dict’s documentation!¶
Contents:
Django-Model-To-Dict¶
Django Model to Python dict serialization mixin.
Based on the original gist: https://gist.github.com/gbezyuk/de29d4888818b87f8addd8143b5331e0
Requirements¶
Currently the package is tested with Python3 and Django 1.10 only.
Documentation¶
The full documentation is at https://django-model-to-dict.readthedocs.io.
Quickstart¶
Install Django-Model-To-Dict:
pip install django-model-to-dict
Add it to your INSTALLED_APPS:
INSTALLED_APPS = (
...
'django_model_to_dict.apps.DjangoModelToDictConfig',
# or just 'django_model_to_dict'
...
)
Use ToDictMixin with your model:
from django_model_to_dict.mixins import ToDictMixin
from django.db import models
class YourModel(models.Model, ToDictMixin):
pass
Since now you model’s instances have the to_dict method defined.
You can setup additional settings both in your global project configuration or in a particular model. See docs for more details.
Features¶
- TODO
Running Tests¶
Does the code actually work?
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
Installation¶
At the command line:
$ easy_install django-model-to-dict
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv django-model-to-dict
$ pip install django-model-to-dict
Usage¶
To use Django-Model-To-Dict in a project, add it to your INSTALLED_APPS:
INSTALLED_APPS = (
...
'django_model_to_dict.apps.DjangoModelToDictConfig',
# or just 'django_model_to_dict'
...
)
Use ToDictMixin with your model:
from django_model_to_dict.mixins import ToDictMixin
from django.db import models
class YourModel(models.Model, ToDictMixin):
pass
Since now you model’s instances have the to_dict method defined.
You can setup additional settings both in your global project configuration or in a particular model.
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/gbezyuk/django-model-to-dict/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
Django-Model-To-Dict could always use more documentation, whether as part of the official Django-Model-To-Dict docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/gbezyuk/django-model-to-dict/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up django-model-to-dict for local development.
Fork the django-model-to-dict repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/django-model-to-dict.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv django-model-to-dict $ cd django-model-to-dict/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 django_model_to_dict tests $ python setup.py test $ tox
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/gbezyuk/django-model-to-dict/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
Development Lead¶
- Grigoriy Beziuk <me@gbezyuk.ru>
Contributors¶
None yet. Why not be the first?