Metadata-Version: 2.1
Name: django-localized-fields
Version: 6.8b1
Summary: Implementation of localized model fields using PostgreSQL HStore fields.
Home-page: https://github.com/SectorLabs/django-localized-fields
Author: Sector Labs
Author-email: open-source@sectorlabs.ro
License: MIT License
Keywords: django,localized,language,models,fields,postgres,hstore,i18n
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: Django >=2.0
Requires-Dist: django-postgres-extra <3.0,>=2.0
Requires-Dist: deprecation ==2.0.7
Requires-Dist: dataclasses ; python_version <= "3.6"
Provides-Extra: analysis
Requires-Dist: black ==22.3.0 ; extra == 'analysis'
Requires-Dist: flake8 ==3.7.7 ; extra == 'analysis'
Requires-Dist: autoflake ==1.3 ; extra == 'analysis'
Requires-Dist: autopep8 ==1.4.4 ; extra == 'analysis'
Requires-Dist: isort ==4.3.20 ; extra == 'analysis'
Requires-Dist: sl-docformatter ==1.4 ; extra == 'analysis'
Provides-Extra: docs
Requires-Dist: Sphinx ==2.2.0 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ==0.4.3 ; extra == 'docs'
Provides-Extra: test
Requires-Dist: tox ==3.14.3 ; extra == 'test'
Requires-Dist: pytest ==5.3.2 ; extra == 'test'
Requires-Dist: pytest-django ==3.7.0 ; extra == 'test'
Requires-Dist: pytest-cov ==2.8.1 ; extra == 'test'
Requires-Dist: dj-database-url ==0.5.0 ; extra == 'test'
Requires-Dist: django-autoslug ==1.9.6 ; extra == 'test'
Requires-Dist: django-bleach ==0.6.1 ; extra == 'test'
Requires-Dist: psycopg2 ==2.8.4 ; extra == 'test'

|  |  |  |
|--------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| :white_check_mark: | **Tests** | [![CircleCI](https://circleci.com/gh/SectorLabs/django-localized-fields/tree/master.svg?style=svg)](https://circleci.com/gh/SectorLabs/django-localized-fields/tree/master) |
| :memo: | **License** | [![License](https://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org) |
| :package: | **PyPi** | [![PyPi](https://badge.fury.io/py/django-localized-fields.svg)](https://pypi.python.org/pypi/django-localized-fields) |
| <img src="https://cdn.iconscout.com/icon/free/png-256/django-1-282754.png" width="22px" height="22px" align="center" /> | **Django Versions** | 2.0, 2.1, 2.2, 3.0, 3.1, 3.2 |
| <img src="http://www.iconarchive.com/download/i73027/cornmanthe3rd/plex/Other-python.ico" width="22px" height="22px" align="center" /> | **Python Versions** | 3.6, 3.7, 3.8, 3.9 |
| :book: | **Documentation** | [Read The Docs](https://django-localized-fields.readthedocs.io) |
| :warning: | **Upgrade** | [Upgrade fom v5.x](https://django-localized-fields.readthedocs.io/en/latest/releases.html#v6-0)
| :checkered_flag: | **Installation** | [Installation Guide](https://django-localized-fields.readthedocs.io/en/latest/installation.html) |

`django-localized-fields` is an implementation of a field class for Django models that allows the field's value to be set in multiple languages. It does this by utilizing the ``hstore`` type (PostgreSQL specific), which is available as `models.HStoreField` since Django 1.10.

---

:warning: **This README is for v6. See the `v5.x` branch for v5.x.**

---

## Working with the code
### Prerequisites

* PostgreSQL 10 or newer.
* Django 2.0 or newer.
* Python 3.6 or newer.

### Getting started

1. Clone the repository:

       λ git clone https://github.com/SectorLabs/django-localized-fields.git

2. Create a virtual environment:

       λ cd django-localized-fields
       λ virtualenv env
       λ source env/bin/activate

3. Create a postgres user for use in tests (skip if your default user is a postgres superuser):

       λ createuser --superuser localized_fields --pwprompt
       λ export DATABASE_URL=postgres://localized_fields:<password>@localhost/localized_fields

   Hint: if you're using virtualenvwrapper, you might find it beneficial to put
   the ``export`` line in ``$VIRTUAL_ENV/bin/postactivate`` so that it's always
   available when using this virtualenv.

4. Install the development/test dependencies:

       λ pip install ".[test]" ".[analysis]"

5. Run the tests:

       λ tox

7. Auto-format code, sort imports and auto-fix linting errors:

       λ python setup.py fix
