https://github.com/exolever/django-changelog

Managing changes during release time
https://github.com/exolever/django-changelog

Last synced: about 1 month ago
JSON representation

Managing changes during release time

• Host: GitHub
• URL: https://github.com/exolever/django-changelog
• Owner: exolever
• License: other
• Created: 2018-08-28T06:33:00.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T20:38:16.000Z (about 2 years ago)
• Last Synced: 2024-04-27T01:02:17.976Z (8 months ago)
• Language: Python
• Size: 83 KB
• Stars: 6
• Watchers: 9
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=============================

django-changelog

=============================

.. image:: https://badge.fury.io/py/exo-changelog.svg

    :target: https://badge.fury.io/py/exo-changelog

    

.. image:: https://requires.io/github/exolever/django-changelog/requirements.svg?branch=master

     :target: https://requires.io/github/exolever/django-changelog/requirements/?branch=master

     :alt: Requirements Status    

.. image:: https://travis-ci.org/exolever/django-changelog.svg

    :target: https://travis-ci.org/exolever/django-changelog

.. image:: https://codecov.io/gh/exolever/django-changelog/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/exolever/django-changelog

    

Manage changelog as migrations

Documentation

-------------

We have two commands, similar to Django Migrations, code based on it. One command creates an empty file ready for write our python code for the change (as a template file with some basic dependencies). We can include commands call or query using our django models.

We manage dependencies between changes at the same way that Django does. And also, we can manage conflicts through merging.

We only have two operations developed: RunPython and RunSQL (both of them, without parameters)

When you want to apply for changes, please execute applychange with/without app_label. You will see messages similar to migrations.

Quickstart

----------

Install django-changelog::

`pip install exo-changelog`

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (

        ...

        'exo_changelog.apps.ExoChangelogConfig',

        ...

    )

Create the changelog table:

`./manage.py migrate exo_changelog`

Features

--------

* Create an empty change:  ./manage.py makechange 

* Execute changes: ./manage.py applychange 

Credits

-------

Tools used in rendering this package:

*  Cookiecutter_

*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage