Metadata-Version: 2.1
Name: django-migrations-tui
Version: 0.1.10
Summary: Manage Django Migrations with a Text-Based UI.
Author-email: Taulant Aliraj <taliraj@outlook.com>
Maintainer-email: Taulant Aliraj <taliraj@outlook.com>
License: MIT License
        
        Copyright (c) 2023 Taulant Aliraj
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/taliraj/django-migrations-tui
Project-URL: Repository, https://github.com/taliraj/django-migrations-tui
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: Django
Requires-Dist: textual>=0.37.0
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-asyncio; extra == "test"
Requires-Dist: pytest-django; extra == "test"

=====================
django-migrations-tui
=====================

Manage Django Migrations with a Text-Based UI

Installation
------------
To install, simply use ``pip``:

.. code-block:: console

    pip install django-migrations-tui

Quick start
-----------

#. Add ``django_migrations_tui`` to your Django project's ``INSTALLED_APPS``.
#. Run the following command to start the interactive UI.

    .. code-block:: console

        python manage.py migrationstui

#. Utilize the arrow keys for navigation and letter keys to perform actions:

   * ``v``: Change the format of the migration view between ``list`` and ``plan``
   * ``l``: Toggle the logs panel
   * ``m``: Run ``migrate`` on the selected migration or app
   * ``f``: Run ``migrate --fake`` on the selected migration or app
   * ``r``: Run ``migrate <app name> zero`` on the selected app
   * ``s``: Run ``sqlmigrate`` on the selected migration
   * ``q``: Quit the UI
   * ``ctrl+\``: Search and select migrations by name
   * Additionally, some vim keybindings are supported for navigation, including ``j``, ``k``, ``ctrl+home``, ``G``, ``ctrl+b`` and ``ctrl+f``.

Screenshots
-----------

.. image:: https://user-images.githubusercontent.com/3104974/274433860-d6d5abf7-0c7f-4dc2-844e-96b3c1d7b404.png
    :alt: Screenshot of django-migrations-tui
    :width: 45%
    :target: https://user-images.githubusercontent.com/3104974/274433860-d6d5abf7-0c7f-4dc2-844e-96b3c1d7b404.png


.. image:: https://user-images.githubusercontent.com/3104974/274433862-58530910-291f-41e6-8c21-b445b5085229.png
    :alt: Screenshot of django-migrations-tui
    :width: 45%
    :target: https://user-images.githubusercontent.com/3104974/274433862-58530910-291f-41e6-8c21-b445b5085229.png
