Skip to main content

Make Django model fields readonly

Project description

https://badge.fury.io/py/django-readonly-field.png https://travis-ci.org/peopledoc/django-readonly-field.png?branch=master https://img.shields.io/codecov/c/github/peopledoc/django-readonly-field/master.svg

Make Django model fields readonly. In other words, make it so that Django will read from your fields in your database, but never try to write them. It can be useful if your fields are populated by triggers or something.

Requirements

  • Postgresql only

  • Django, obviously. v1.8+ (until proven otherwise)

  • Running under Python 2.7 or 3.4+

Documentation

The full documentation is at https://django-readonly-field.readthedocs.org.

Quickstart

Install Django Readonly Field:

pip install django-readonly-field

In your settings.py :

INSTALLED_APPS = [
    # ...
    "django_readonly_field",
]

In the model where you want some fields to be read-only:

class Spaceship(models.Model):
    name = models.CharField(max_length=100)
    color = models.CharField(max_length=16)

    class ReadonlyMeta:
        readonly = ["color"]

That’s it. Now, Django won’t try to write the color field on the database.

Warning

Django won’t try to write those fields. Consequence is that your Database must be ok with Django not writing those fields. They should either be nullable or have a database default or be filled by a trigger, otherwise you will get an IntegrityError.

Don’t forget that Django model field defaults won’t become database defaults. You might have to write an SQL migration for this.

Running Tests

You will need an usable Postgresql database in ordre to test the project.

source <YOURVIRTUALENV>/bin/activate
export DATABASE_URL=postgres://USER:PASSWORD@HOST:PORT/NAME
(myenv) $ pip install -r requirements_test.txt

Run tests for a specific version

(myenv) $ python runtests.py

Run tests for all versions (if tox is installed globally, you don’t need a virtual environment)

$ tox

Using the project

Many operations are documented in the Makefile. For more information, use:

$ make help

Credits

Tools used in rendering this package:

History

1.0.3 (2018-04-26)

  • Python 3.6 support

  • Multiple databases support

  • Github organization changed to “peopledoc”

1.0.2 (2017-09-22)

  • Added tests for Django 1.11

1.0.1 (2016-10-19)

  • Added support for Python 3.4 and current Django stable

  • Fix a thread bug that would make the package usable only for test and not for real :/

1.0.0 (2016-09-15)

  • First stable version

0.2.0 (2016-09-14)

  • Rationalized the writing of readonly (vs read-only)

  • Defined default app config

0.1.1 (2016-09-13)

  • CI improvements

  • Code linting

0.1.0 (2016-09-02)

  • First release on PyPI.

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-readonly-field-1.0.3.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

django_readonly_field-1.0.3-py2.py3-none-any.whl (7.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file django-readonly-field-1.0.3.tar.gz.

File metadata

File hashes

Hashes for django-readonly-field-1.0.3.tar.gz
Algorithm Hash digest
SHA256 f2afc8e02996aa9e169846bb79fa07df833d5fc2c63149bf29e531bef905fe10
MD5 5bf065d360287c7b7d7279545a269b3b
BLAKE2b-256 67e7c1e3953f6963280357e68af202a8b8f498462372704daa306feb6ab65efe

See more details on using hashes here.

File details

Details for the file django_readonly_field-1.0.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_readonly_field-1.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 568806a123f966257987f1c17037288c3e8eb648f293cef306a49235822aa2a9
MD5 799befe467292908d8f6f07a6994b344
BLAKE2b-256 bf23902e59bfc5552d8151eb739ed4fafbdba61bb7f7436750a35d675c797695

See more details on using hashes here.

Supported by

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