Skip to main content

Implementation of localized model fields using PostgreSQL HStore fields.

Project description

:white_check_mark: Tests CircleCI
:memo: License License
:package: PyPi PyPi
Django Versions 2.0, 2.1, 2.2, 3.0, 3.1
Python Versions 3.6, 3.7, 3.8, 3.9
:book: Documentation Read The Docs
:warning: Upgrade Upgrade fom v5.x
:checkered_flag: Installation Installation Guide

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 psqlextra --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
    
  6. Auto-format code, sort imports and auto-fix linting errors:

    λ python setup.py fix
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-localized-fields, version 6.4
Filename, size File type Python version Upload date Hashes
Filename, size django_localized_fields-6.4-py3-none-any.whl (30.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-localized-fields-6.4.tar.gz (21.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page