Skip to main content
Help us improve Python packaging – donate today!

A simple Django app for command-line searching via the ORM

Project Description

django_grepdb is a simple command-line app to provide basic grep-like searching of Django model fields using the ORM. Written to facilitate searching for a tag, filter, named url etc in templates in the database, but can also be used to quickly find model instances from the command line.

Quick start

  1. Add “django_grepdb” to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = (
        ...
        'django_grepdb',
    )
    

    or, if you have a separate settings file for development in which you extend your global settings, like this:

    INSTALLED_APPS = INSTALLED_APPS + ('django_grepdb',)
    
  2. Run:

    $ python manage.py grepdb <pattern> <app_label.Model.field_name>
    

Usage

Find instances of {% custom_template_tag.*%} in all text fields on the model EmailAction from app sprinkle, show lines containing matches, and generate admin links (if django.contrib.admin is installed):

$ python manage.py grepdb "{% custom_template_tag.*%}" sprinkle.EmailAction
<class 'sprinkle.models.EmailAction'> text_field

User registered (pk=13)
localhost:8000/admin/sprinkle/emailaction/13/
<p>Hi {% custom_template_tag user.get_full_name %},</p>

Password reset request (pk=24)
localhost:8000/admin/sprinkle/emailaction/24/
<p>Hi, {% custom_template_tag user.get_full_name %}</p>

Options

Options are listed using $ python manage.py grepdb --help but here are some of the things you can do with django_grepdb.

Search multiple models:

$ python manage.py grepdb <pattern> sprinkle.EmailAction cms.MarkdownNode

Specify fields instead of finding all text fields:

$ python manage.py grepdb <pattern> sprinkle.EmailAction.body sprinkle.EmailAction.subject

Find all instances of CharField instead of TextField:

$ python manage.py grepdb <pattern> sprinkle.EmailAction -c

Show the whole field of a match rather than just the line:

$ python manage.py grepdb <pattern> sprinkle.EmailAction -sa

Change the hostname of the admin links:

$ python manage.py grepdb <pattern> sprinkle.EmailAction -l https://dev.example.com

Specify hostname key-value pairs in settings:

DJANGO_GREPDB_SITES = {
    'default': 'https://staging.example.com'
    'dev': 'https://dev.example.com',
}

$ python manage.py grepdb <pattern> sprinkle.EmailAction -l dev

Specify preset configurations in settings:

DJANGO_GREPDB_PRESETS = {
    'users': dict(identifiers=['auth.user', 'projects.userprofile'],
                  field_type=['CharField', 'TextField'],
                  ignore_case=True),
    'templates': dict(identifiers=['sprinkle.EmailAction', 'cms.HTMLNode', 'cms.TextNode', 'cms.MarkdownNode'])

$ python manage.py grepdb <pattern> -p templates

Release history Release notifications

This version
History Node

1.1.2

History Node

1.1.1

History Node

1.1.0

History Node

1.0.0

History Node

0.1.7

History Node

0.1.6

History Node

0.1.5

History Node

0.1.4

History Node

0.1.2

History Node

0.1.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django_grep_db-1.1.2-py2.py3-none-any.whl (16.5 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Nov 8, 2015
django-grep-db-1.1.2.tar.gz (11.0 kB) Copy SHA256 hash SHA256 Source None Nov 8, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page