django-readonly-field

============================= Django Readonly Field

|pypi| |version| |github| |ci| |doc| |cov| |license|

.. |pypi| image:: https://img.shields.io/pypi/v/django-readonly-field?logo=pypi&logoColor=white :target: https://pypi.org/pypi/django-readonly-field :alt: Deployed to PyPI

.. |version| image:: https://img.shields.io/pypi/pyversions/django-readonly-field?logo=pypi&logoColor=white :target: https://pypi.org/pypi/django-readonly-field :alt: Python library

.. |github| image:: https://img.shields.io/github/stars/botify-labs/django-readonly-field?logo=github :target: https://github.com/botify-labs/django-readonly-field/ :alt: GitHub Repository

.. |ci| image:: https://img.shields.io/github/actions/workflow/status/botify-labs/django-readonly-field/ci.yml?logo=github&branch=main :target: https://github.com/botify-labs/django-readonly-field/actions?workflow=CI :alt: Continuous Integration

.. |doc| image:: https://img.shields.io/readthedocs/django-readonly-field/stable?logo=read-the-docs&logoColor=white :target: https://django-readonly-field.readthedocs.io/ :alt: Documentation

.. |cov| image:: https://raw.githubusercontent.com/botify-labs/django-readonly-field/python-coverage-comment-action-data/badge.svg :target: https://github.com/botify-labs/django-readonly-field/tree/python-coverage-comment-action-data :alt: Coverage

.. |license| image:: https://img.shields.io/github/license/botify-labs/django-readonly-field?logo=open-source-initiative&logoColor=white :target: https://github.com/botify-labs/django-readonly-field/blob/master/LICENSE :alt: MIT License

Make some Django model fields readonly. In other words, it lets you tell Django to read some fields from your database, but never try to write those back. It can be useful if your fields are populated by triggers or something.

Requirements

• Postgresql only
• Django, tested from 4.2 to 5.1
• With Python, tested from 3.8 to 3.12

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 :

.. code-block:: python

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

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

.. code-block:: python

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 a usable Postgresql database in order to test the project.

::

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

Run tests for a specific version

::

(myenv) $ pytest

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

::

$ tox

Credits

This repository was once available at peopledoc/django-readonly-field <https://github.com/peopledoc/django-readonly-field>_.

Tools used in rendering this package:

• Cookiecutter_
• cookiecutter-djangopackage_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _cookiecutter-djangopackage: https://github.com/pydanny/cookiecutter-djangopackage