django-scripts-tracker 0.2

Quick feature preview

Step 1 - decorate your management script handle() method with @tracked_script decorator and push it to repository:

class Command(BaseCommand):
    help = 'Some sample script help text'

    @tracked_script
    def handle(self, *args, **options):
        # (...)

Step 2 - anyone who pulls your changes and runs migrations, will get a notification message:

$ python manage.py migrate
(...)
Running migrations:
  (...)
Checking management scripts:
  You have 1 new and 0 modified management scripts to be applied.
New scripts (1):
  your_app/management/commands/sample_management_script.py
    Some sample script help text

Installation

1. Install the app using pip package manager:

   pip install django-scripts-tracker

2. Add django_scripts_tracker to your INSTALLED_APPS setting:

   # your_app/settings.py
   INSTALLED_APPS = [
       # (...)
       'django_scripts_tracker',
   ]

3. Run migrations in order to create tracker models:

   python manage.py migrate

4. Configure directories that should be scanned for management scripts:

   # your_app/settings.py
   COMMANDS_DIRS = [
       'your_app/management/commands',
       'another_app/management/commands',
   ]

Usage

python manage.py check_scripts

python manage.py check_scripts --mark-all-applied

Read more

For more information visit home page:

https://krzysiek555.github.io/django-scripts-tracker