https://github.com/barseghyanartur/django-strawberry
Additional fields for(ever) Django.
https://github.com/barseghyanartur/django-strawberry
django django-fields md5-hash
Last synced: 7 months ago
JSON representation
Additional fields for(ever) Django.
- Host: GitHub
- URL: https://github.com/barseghyanartur/django-strawberry
- Owner: barseghyanartur
- Created: 2018-05-20T01:50:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-28T15:46:29.000Z (almost 6 years ago)
- Last Synced: 2024-04-25T13:00:43.918Z (over 1 year ago)
- Topics: django, django-fields, md5-hash
- Language: Python
- Homepage: https://pypi.python.org/pypi/django-strawberry
- Size: 58.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE_GPL2.0.txt
Awesome Lists containing this project
README
=================
django-strawberry
=================
Additional fields for(ever) Django.
.. image:: https://img.shields.io/pypi/v/django-strawberry.svg
:target: https://pypi.python.org/pypi/django-strawberry
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/django-strawberry.svg
:target: https://pypi.python.org/pypi/django-strawberry/
:alt: Supported Python versions
.. image:: https://img.shields.io/travis/barseghyanartur/django-strawberry/master.svg
:target: http://travis-ci.org/barseghyanartur/django-strawberry
:alt: Build Status
.. image:: https://readthedocs.org/projects/django-strawberry/badge/?version=latest
:target: http://django-strawberry.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/license-GPL--2.0--only%20OR%20LGPL--2.1--or--later-blue.svg
:target: https://github.com/barseghyanartur/django-strawberry/#License
:alt: GPL-2.0-only OR LGPL-2.1-or-later
.. image:: https://coveralls.io/repos/github/barseghyanartur/django-strawberry/badge.svg?branch=master
:target: https://coveralls.io/github/barseghyanartur/django-strawberry?branch=master
:alt: Coverage
Prerequisites
=============
- Django 1.11, 2.0, 2.1, 2.2 and 3.0.
- Python 2.7, 3.6, 3.7 and 3.8.
Documentation
=============
Documentation is available on `Read the Docs
`_.
Main features and highlights
============================
- MD5Field.
Installation
============
(1) Install latest stable version from PyPI:
.. code-block:: sh
pip install django-strawberry
or latest stable version from GitHub:
.. code-block:: sh
pip install https://github.com/barseghyanartur/django-strawberry/archive/stable.tar.gz
or latest stable version from BitBucket:
.. code-block:: sh
pip install https://bitbucket.org/barseghyanartur/django-strawberry/get/stable.tar.gz
Usage
=====
MD5 field
---------
In case you want to have an MD5 field populated from another field of the same
model.
Example 1
~~~~~~~~~
**myapp/models.py**
.. code-block:: python
from django.db import models
from strawberry.fields import MD5Field
class MyModel(models.Model):
title = models.CharField(max_length=255)
title_hash = MD5Field(
populate_from='title',
null=True,
blank=True
)
def __str__(self):
return self.title
**myapp/example.py**
.. code-block:: python
from myapp.models import MyModel
mymodel = MyModel.objects.create(title="Lorem7")
print(mymodel.title_hash)
'd48a712e77902d0558a3721d9a4740c9'
Example 2
~~~~~~~~~
The `populate_from` argument can also be a callable, that would expect
the model instance as an argument. Thus, example identical to the first one
would be:
**myapp/models.py**
.. code-block:: python
from django.db import models
from strawberry.fields import MD5Field
def strip_title(instance):
return instance.title.strip()
class MyModel(models.Model):
title = models.CharField(max_length=255)
title_hash = MD5Field(
populate_from=strip_title,
null=True,
blank=True,
)
def __str__(self):
return self.title
**myapp/example.py**
.. code-block:: python
from myapp.models import MyModel
mymodel = MyModel.objects.create(title=" Lorem7 ")
print(mymodel.title_hash)
'd48a712e77902d0558a3721d9a4740c9'
Testing
=======
Project is covered with tests.
To test with all supported Python/Django versions type:
.. code-block:: sh
tox
To test against specific environment, type:
.. code-block:: sh
tox -e py38-django30
To test just your working environment type:
.. code-block:: sh
./runtests.py
To run a single test in your working environment type:
.. code-block:: sh
./runtests.py src/strawberry/tests/test_fields.py
Or:
.. code-block:: sh
./manage.py test strawberry.tests.test_fields
It's assumed that you have all the requirements installed. If not, first
install the test requirements:
.. code-block:: sh
pip install -r examples/requirements/test.txt
Writing documentation
=====================
Keep the following hierarchy.
.. code-block:: text
=====
title
=====
header
======
sub-header
----------
sub-sub-header
~~~~~~~~~~~~~~
sub-sub-sub-header
^^^^^^^^^^^^^^^^^^
sub-sub-sub-sub-header
++++++++++++++++++++++
sub-sub-sub-sub-sub-header
**************************
License
=======
GPL-2.0-only OR LGPL-2.1-or-later
Support
=======
For any issues contact me at the e-mail given in the `Author`_ section.
Author
======
Artur Barseghyan