Skip to main content

Tool for finding removed features in your Django project

Project description

PyPI release Downloads Coverage Linting Coding Style Documentation Status

Welcome to the django-removals - a maintainer's best friend for finding removed features in your Django project

PyPI | GitHub | Full documentation

Creator & Maintainer: Ambient Digital

Features

This package will throw Django system checks warnings for all known removals from Django v1.0 to today.

Here's an example:

Example system check

The checks will either be triggered when using the Django development server

python manage.py runserver

or when you call the checks manually

python manage.py check --deploy

It focuses on Django settings but might also add more checks in the future.

Installation

  • Install the package via pip:

    pip install django-removals

    or via pipenv:

    pipenv install django-removals

  • Add module to INSTALLED_APPS within the main django settings.py:

    INSTALLED_APPS = (
        # ...
        "django_removals",
    )
    

Since this package adds only Django system checks, which don't run on production, you could add it only when being in (local) debug mode.

if DEBUG_MODE:
    INSTALLED_APPS += ("django_removals",)

Publish to ReadTheDocs.io

  • Fetch the latest changes in GitHub mirror and push them
  • Trigger new build at ReadTheDocs.io (follow instructions in admin panel at RTD) if the GitHub webhook is not yet set up.

Preparation and building

This package uses uv for dependency management and building.

  • Update documentation about new/changed functionality

  • Update the CHANGES.md

  • Increment version in main __init__.py

  • Create pull request / merge to "main"

  • This project uses uv to publish to PyPI. This will create distribution files in the dist/ directory.

    uv build
    

Publishing to PyPI

To publish to the production PyPI:

uv publish

To publish to TestPyPI first (recommended for testing):

uv publish --publish-url https://test.pypi.org/legacy/

You can then test the installation from TestPyPI:

uv pip install --index-url https://test.pypi.org/simple/ ambient-package-update

Maintenance

Please note that this package supports the ambient-package-update. So you don't have to worry about the maintenance of this package. This updater is rendering all important configuration and setup files. It works similar to well-known updaters like pyupgrade or django-upgrade.

To run an update, refer to the documentation page of the "ambient-package-update".

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_removals-1.1.5.tar.gz (100.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_removals-1.1.5-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file django_removals-1.1.5.tar.gz.

File metadata

  • Download URL: django_removals-1.1.5.tar.gz
  • Upload date:
  • Size: 100.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.1

File hashes

Hashes for django_removals-1.1.5.tar.gz
Algorithm Hash digest
SHA256 c1c913047f75397269a828ee80835aade328fa10e70f7c84143f8e7c991b1fcd
MD5 08e02893606820c0db24871e4a21bf59
BLAKE2b-256 ffbf16187e4c7d096c5ed79274e75964c8c89cffadf8292b04fa30d7517664ec

See more details on using hashes here.

File details

Details for the file django_removals-1.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for django_removals-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 24936de4ea6ef95934f881ca86def685a2b125d53f19253c00d3360f1578e07c
MD5 984b661a869f8286a3a3fea09eb99dbf
BLAKE2b-256 18acc1df8e76f5265d432064c78c725e2155df419645bc56ef1de65e60de96e9

See more details on using hashes here.

Supported by

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