Metadata-Version: 2.4
Name: CTRL-Z
Version: 1.5.2
Summary: A Django backup and recovery tool
Home-page: https://github.com/isprojects/ctrl-z
Author: ISPnext B.V, Sergei Maertens
Author-email: support@ispnext.com
License: MIT
Keywords: django,backup,recovery
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.2
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
License-File: LICENSE
Requires-Dist: django
Requires-Dist: python-dateutil
Requires-Dist: pyyaml
Provides-Extra: tests
Requires-Dist: psycopg2-binary; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-django; extra == "tests"
Requires-Dist: freezegun; extra == "tests"
Requires-Dist: pytest-mock; extra == "tests"
Requires-Dist: tox; extra == "tests"
Requires-Dist: isort; extra == "tests"
Provides-Extra: pep8
Requires-Dist: flake8; extra == "pep8"
Provides-Extra: coverage
Requires-Dist: pytest-cov; extra == "coverage"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Provides-Extra: release
Requires-Dist: zest.releaser; extra == "release"
Dynamic: license-file

==========================================
CTRL-Z - A Django backup and recovery tool
==========================================

CTRL-Z (control-zee) is a backup and recovery tool for Django projects.

Its goals are to be operating system agnostic in creating and restoring backups,
while being flexible through a yaml configuration file.

|coverage| |docs|

|python-versions| |django-versions| |pypi-version|

.. note:: Warning: currently only PostgreSQL is supported

.. contents::

.. section-numbering::

Features
========

* Supports Linux, Windows, MacOS
* Django project inspection:

    * backs up configured databases using ``settings.DATABASES``
    * backs up file directories such as ``settings.MEDIA_ROOT`` (configurable)

* stdlib ``logging`` based reporting + e-mailing of backup/restore report
* YAML-based, minimal configuration
* Simple Python/CLI APIs for backup creation and restoration

Installation and usage
======================

See the `documentation`_.

.. |coverage| image:: https://codecov.io/gh/isprojects/ctrl-z/branch/develop/graph/badge.svg
    :target: https://codecov.io/gh/isprojects/ctrl-z
    :alt: Coverage status

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/ctrl-z.svg

.. |django-versions| image:: https://img.shields.io/pypi/djversions/ctrl-z.svg

.. |pypi-version| image:: https://img.shields.io/pypi/v/ctrl-z.svg
    :target: https://pypi.org/project/ctrl-z/

.. |docs| image:: https://readthedocs.org/projects/ctrl-z/badge/?version=latest
    :target: https://ctrl-z.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. _documentation: https://ctrl-z.readthedocs.io/en/latest/
