Skip to main content

Make Django model fields readonly

Project description

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

Make Django model fields readonly. In other words, make it so that Django will read from your field in your Database, but never try to write it. It can be useful if your field is populated by a trigger or something.

Requirements

  • Postgresql only
  • Django, obviously

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 in IntegrityError.

Don’t forget that Django model field defaults don’t become Database default. 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

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.

Files for django-readonly-field, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size django_readonly_field-0.1.0-py2.py3-none-any.whl (6.0 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size django-readonly-field-0.1.0.tar.gz (6.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page