Make Django model fields readonly
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
django_readonly_field
docs
tests Moved test manage.py Oct 19, 2016
.editorconfig
.gitignore
.travis.yml
AUTHORS.rst
CONTRIBUTING.rst
HISTORY.rst
LICENSE
MANIFEST.in
Makefile
README.rst
requirements.txt
requirements_dev.txt
requirements_test.txt
runtests.py
setup.cfg
setup.py
tests_manage.py
tox.ini

README.rst

Django Readonly Field

https://badge.fury.io/py/django-readonly-field.png https://travis-ci.org/peopledoc/django-readonly-field.png?branch=master

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: