Versioning and support
Maintenance mode
django-components is in maintenance mode. New releases bring:
- security fixes,
- support for new Django and Python versions,
- bug fixes.
New features go to Citry, a Python frontend framework that grew out of django-components and works with Django. To move a project over one component at a time, follow the migration guide.
Kinds of release
django-components follows semantic versioning.
- Patch (1.0.0 to 1.0.1): bug fixes and security fixes.
- Minor (1.0.0 to 1.1.0): can add support for a new Django or Python version, deprecate a feature, or drop a Django or Python version that has reached its end of life.
- Major (2.0.0): may remove deprecated features and make other breaking changes. No 2.0.0 release is planned.
What 1.x promises
Code that uses the public API keeps working on every 1.x release, with two exceptions:
- A minor release can drop a Django or Python version that has reached its end of life (see Django and Python).
- A security fix can refuse input that earlier releases accepted, or handle it differently (for example, render it escaped), when that is needed to close a security hole. The release notes for that release say so.
Any other change that would break the public API waits for 2.0.0.
A deprecated feature keeps working until 2.0.0. The documentation marks it as deprecated and tells you to stop using it.
What the public API is
The public API is everything this documentation describes: the behavior the guides describe, and every page under API reference, such as the classes and functions, settings, template tags, middleware, URLs, commands, signals, the testing API and extension hooks.
Anything the documentation does not describe is internal. Internal code may change in any release, even a patch release. If you rely on it, pin the exact django-components version and test each upgrade.
Which releases get fixes
Bug and security fixes go to the newest 1.x minor release only. Once 1.2.0 is out, a fix ships as 1.2.1, not as a 1.1.x release. With django-components>=1.0.0,<2, upgrading gives you the release that gets fixes.
0.x releases get no fixes. To move to 1.x, see Upgrading from 0.x versions.
To report a security problem, follow the security policy.
Django and Python
- Each Django version is supported until Django's own end of life for it.
- Each Python version is supported until it reaches its end of life.
- A version is dropped only in a minor release, never in a patch release. The release notes name the version.
When your Django or Python version is dropped, your installer keeps the last release that supports it. That release gets no more fixes, so upgrade Django or Python to keep getting them.
The Compatibility page lists the Python and Django versions that the current release supports.