Skip to main content

Convenient soft-deletion support for Django models

Project description

django-livefield

About

A Django field that enables convenient soft-deletion. For Python 2.7/3.3+ and Django 1.8+

Installation

Simple: pip install django-livefield.

Example Usage

>>> from django.db import models
>>> from livefield import LiveField, LiveManager
>>>
>>>
>>> class Person(models.Model):
...    name = models.CharField()
...    live = LiveField()
...
...    objects = LiveManager()
...    all_objects = LiveManager(include_soft_deleted=True)
...
...    class Meta:
...        unique_together = ('name', 'live')
...
...    def delete(self, using=None):
...        self.live = False
...        self.save(using=using)
...
>>> john = Person.objects.create(name='John Cleese')
>>> doppelganger = Person(name='John Cleese')
>>> doppelganger.save()  # Raises an IntegrityError
>>> john.delete()
>>> doppelganger.save()  # Succeeds!

License

MIT. See LICENSE.txt for details.

Contributing

Pull requests welcome! To save everyone some hassle, please open an issue first so we can discuss your proposed change.

In your PR, be sure to add your name to AUTHORS.txt and include some tests for your spiffy new functionality. CI will green-light your build once it passes the unit tests (./setup.py test) and our linters (./lint.sh).

Changelog

4.1.0

  • Add support for Python 3.12

  • Add support for Django 5.0

4.0.0

  • Add support for Python 3.8 - 3.11

  • Add support for Django 4.1 and 4.2

  • Remove support for old Django versions

  • Remove support for old Python versions

3.3.0

  • Django 3.x support

  • switch to BooleanField as base (Django 4.x deprecation)

3.2.1

  • Fix rST formatting in this file to pass PyPI rendering check

3.2.0 (Not released)

  • Support Django 2.2

  • Support Python 3.7

  • Fix metadata to remove deprecated Django versions

  • Expand travis tests for versions and database engines

  • Remove obsolete pylint suppressions

  • Thanks to [@shurph](https://github.com/shurph) for the above!

3.1.0

3.0.0

  • Add support for Python 3.6

  • Add support for Django 2.0

  • Remove support for Python 3.4

  • Remove support for old Django versions

  • Remove GIS

2.5.0 (Not released)

  • Added official Python 3 support.

  • Re-added support for Django 1.8. Now supports Django 1.8 and 1.9.

2.4.0 (2016-02-11)

  • Drop support for Django 1.8

  • Add number of affected rows for delete methods (hard_delete, soft_delete, delete). Note: Django 1.9+ only.

2.1.0 (2014-09-04)

  • Add support for Django 1.7.

2.0.0 (2014-07-13)

  • Renamed top-level namespace to livefield.

  • Restructured internally to match Django convention.

  • Added GIS support.

  • Added South support.

1.0.0 (2014-02-14)

  • Initial release.

  • Separated existing code from main application repository.

Developed and maintained by Hearsay Social, Inc..

Contributors

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-livefield-4.1.0.tar.gz (7.4 kB view hashes)

Uploaded source

Built Distribution

django_livefield-4.1.0-py2.py3-none-any.whl (6.9 kB view hashes)

Uploaded py2 py3

Supported by

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