django-codemod 0.17.2

Collections of libCST codemodders to upgrade Django

Django Codemod

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

Installation

Install 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 run --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 run --removed-in 4.0 .

Explanations

In either case, the tool will run for 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 📖

Chris VanderKolk 💻

John Vandenberg 🐛 💻

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.