Collections of libCST codemodders to upgrade Django

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Bruno.Alla from gravatar.com Bruno.Alla

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT license)
  • Author: Bruno Alla
  • Tags django, codemod, libCST
  • Requires: Python >=3.6
Classifiers

Project description

Django Codemod

GitHub Workflow Status Documentation Status Test coverage percentage black

PyPi Status pyversions license LoC

A tool to help upgrade Django projects to newer version of the framework by automatically fixing deprecations.

Installation

Install this via pip (or your favourite installer):

pip install django-codemod

Usage

2 main workflow are supported:

  • Prepare future upgrades by modifying code which is deprecated in a given version using the deprecated-in option
  • Fix previous deprecated code which is removed in a given version using the removed-in option

1. Deprecations

Let's say you just updated to Django 3.0, and suddenly you're flooded with deprecations warning on your CI (you have warning enabled on CI, right?).

You want to resolve them to avoid missing another important warning. You can do so by running the following command from the root of your repo:

djcodemod --deprecated-in 3.0 .

2. Removals

This is more a just in time operation, assuming you haven't kept up to date with deprecation warnings, and right before upgrading to a given version (let's assume Django 4.0). In this case, you should be running:

djcodemod --removed-in 4.0 .

What happens

In either case, the tool will take a few minutes and apply a set of modifications to your code to fix deprecated or removed usages of Django. This should be much faster than doing it manually and much robust than a simple find & replace.

Check out the documentation for more detail on usage and the full list of codemodders.

How it works

This is based on libCST and implements codemods for it. This is currently very limited but the aim is to add more for helping with upcoming deprecations.

Not finding what you need? I'm open to contributions, please send me a pull request.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Bruno Alla
💻 🐛 📖
Adam Johnson
📖
Nikita Sobolev
📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Bruno.Alla from gravatar.com Bruno.Alla

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT license)
  • Author: Bruno Alla
  • Tags django, codemod, libCST
  • Requires: Python >=3.6
Classifiers

Release history Release notifications | RSS feed

2.2.1

2.2.0

2.1.11

2.1.10

2.1.9

2.1.8

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.0

1.11.7

1.11.6

1.11.5

1.11.4

1.11.3

1.11.2

1.11.1

1.11.0

1.10.8

1.10.7

1.10.6

1.10.5

1.10.4

1.10.3

1.10.2

1.10.1

1.10.0

1.9.1

1.9.0

1.8.2

1.8.1

1.8.0

1.7.1

1.7.0

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.8

1.5.7

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.1

1.4.0

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.0

1.1.0

1.0.0

0.21.0

0.20.0

0.19.0

0.18.0

0.17.5

0.17.4

0.17.3

0.17.2

0.17.1

0.17.0

0.16.0

0.15.0

0.14.0

0.13.3

0.13.2

0.13.1

0.13.0

0.12.0

0.11.0

0.10.1

0.10.0

This version

0.9.0

0.8.1

0.8.0

0.7.0

0.6.0

0.5.0

0.4.0

0.3.0

0.2.1

0.2.0

0.1.1

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-codemod-0.9.0.tar.gz (21.6 kB view details)

Uploaded Source

Built Distribution

django_codemod-0.9.0-py2.py3-none-any.whl (16.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-codemod-0.9.0.tar.gz.

File metadata

  • Download URL: django-codemod-0.9.0.tar.gz
  • Upload date:
  • Size: 21.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

File hashes

Hashes for django-codemod-0.9.0.tar.gz
Algorithm Hash digest
SHA256 05c7865467394fbf9b41b92cbe8400e457b92ad726d20a3c394cba38f00a6694
MD5 b9c101cd825da74d760a4362c296892d
BLAKE2b-256 751b20788ee24c0d177203dd96b41ca51065243f3f7b05d73bd7f8f2763d3d18

See more details on using hashes here.

File details

Details for the file django_codemod-0.9.0-py2.py3-none-any.whl.

File metadata

  • Download URL: django_codemod-0.9.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

File hashes

Hashes for django_codemod-0.9.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1eeb9265ace89bc7d671dafab39738631b71cd49435575336aba9e3e1a28c0fa
MD5 81db301091d24c83fe5ff330f67e60ca
BLAKE2b-256 40d9f755b59eb37d4b4dfbd1eb8a8f49e58ad5a14b9140c884d629968616bc3b

See more details on using hashes here.

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