Skip to main content

An unofficial Django utility tool that tracks management scripts execution

Project description

PyPI version Code Health Python versions Django versions License

Django Scripts Tracker

An unofficial Django utility tool that tracks management scripts execution.

What does it mean “to track script execution”?

Scripts tracker watches scripts located in your_app/management/commands directory and just after you pull some new code and apply its migrations - you will get notified about new (or modified) scripts that should be applied for the project to work properly.

Home page:

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'

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

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

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


  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/
        # (...)
  3. Run migrations in order to create tracker models:

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

    # your_app/


How to add a new tracked script?

  1. Create a new management script under a tracked (...)/management/commands/ directory (tracked directories are defined in COMMANDS_DIRS).

  2. Decorate either handle() or handle_noargs() Command method with a @tracked_script decorator.

  3. Make sure that the created script file is not ingored and is within a tracked directory.

How to check if there are unapplied scripts?

Script checking process takes place every time you perform DB migrations, but you can also invoke it manually:

python check_scripts

How to mark scripts as “applied” ones?

Scripts are automatically marked as applied ones just after their execution.

If there are some scripts that have already been applied but the tracker lists them - it is possible to mark them manually as applied ones.

To mark scripts as “applied” ones type in the following command:

python check_scripts --mark-all-applied

Read more

For more information visit home page:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-scripts-tracker-0.2.tar.gz (11.4 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page