Skip to main content

Store internationalized strings in Django models

Project description

https://img.shields.io/pypi/v/django-i18nfield.svg https://readthedocs.org/projects/django-i18nfield/badge/?version=latest https://travis-ci.org/raphaelm/django-i18nfield.svg?branch=master https://codecov.io/gh/raphaelm/django-i18nfield/branch/master/graph/badge.svg

This is yet another way to store multi-lingual content in Django. In contrast to other options like django-hvad, django-modeltranslation or django-parler it does not require additonal database tables and you can reconfigure the available languages without any changes to the database schema. In constrast to nece, it is not specific to PostgreSQL.

How does it work then? It stores JSON data into a TextField. Yes, this is kinda dirty and violates the 1NF. This makes it harder for non-django based programs to interact directly with your database and is not perfectly efficient in terms of storage space. It also lacks the ability to do useful lookups, searches and indices on internationalized fields. If one of those things are important to you, this project is not for you, please choose one of the ones that we linked above.

However if those limitations are fine for you, this provides you with a very lightweight, easy to use and flexible solution. This approach has been in use in pretix for quite a while, so it has been tested in production. The package contains not only the model fields, but also form fields and everything you need to get them running.

Features

  • Very easy installation

  • Internationalized versions of CharField and TextField types

  • Integrated form fields types and widgets

  • Automatic migration from non-localized fields with a simple migration

  • Full support for forms and formsets

  • Possibility to dynamically limit the displayed languages

  • Very basic integration with django admin

  • Integration with Django Restframework

  • Comprehensive test suite and production-tested

Tested with:

  • Python 3.9 to 3.13

  • Django supported versions: 4.2, 5.1 and 5.2

Security

If you discover a security issue, please contact us at security@pretix.eu and see our Responsible Disclosure Policy further information.

License

The code in this repository is published under the terms of the Apache License. See the LICENSE file for the complete license text.

This project is maintained by Raphael Michel <mail@raphaelmichel.de>. See the AUTHORS file for a list of all the awesome folks who contributed to this project.

Project details


Download files

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

Source Distribution

django_i18nfield-1.11.0.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_i18nfield-1.11.0-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file django_i18nfield-1.11.0.tar.gz.

File metadata

  • Download URL: django_i18nfield-1.11.0.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for django_i18nfield-1.11.0.tar.gz
Algorithm Hash digest
SHA256 0b5ce5fd6d01134c872587cc08ff45ba60de91e826170480769c241ff93636aa
MD5 bb7af40dbb0a799bb88f4f405776e8c4
BLAKE2b-256 b042655f7a255247c72f35158f3da51168a4a05b0eaaa1d84a0f356e9620cecb

See more details on using hashes here.

File details

Details for the file django_i18nfield-1.11.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_i18nfield-1.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0cd84a6e8db83810cc935eae4c19c5244ac26f2ff5e781cb680ce37e2104f625
MD5 485afadbcc5f12055bf5ac7a09bfa028
BLAKE2b-256 700f2326bcebdb24a73e8b05d4f12cd7a2b13890356f7c98511cd3214045fc42

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page