# grunt-contrib-django

> Grunt tasks to run common django commands. Inspired from rockabox/grunt-django-manage

Latest version **0.3.0** (published 2016-01-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install grunt-contrib-django
pnpm add grunt-contrib-django
yarn add grunt-contrib-django
bun add grunt-contrib-django
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2016-01-04 |
| First published | 2014-09-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Maintainers | nicolaspanel |
| Keywords | django, manage.py, django-admin.py, grunt |

## Links

- npm: https://www.npmjs.com/package/grunt-contrib-django
- Repository: https://github.com/nicolaspanel/grunt-contrib-django
- Issues: https://github.com/nicolaspanel/grunt-contrib-django/issues
- npm.io page: https://npm.io/package/grunt-contrib-django

## Dependencies (4)

- [q](https://npm.io/package/q.md) ^1.1.2
- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [p-throttler](https://npm.io/package/p-throttler.md) ^0.1.1
- [string-format](https://npm.io/package/string-format.md) ^0.2.1

## Recent versions

- 0.3.0 (latest) — 2016-01-04
- 0.2.2 — 2015-01-30
- 0.2.1 — 2015-01-30
- 0.2.0 — 2014-11-24
- 0.1.0 — 2014-09-17

## README

# grunt-contrib-django

Grunt tasks to run [common django commands](https://docs.djangoproject.com/en/dev/ref/django-admin/).

[![NPM](https://nodei.co/npm/grunt-contrib-django.png?downloads=true)](https://nodei.co/npm/grunt-contrib-django/)
[![Build Status](https://travis-ci.org/nicolaspanel/grunt-contrib-django.svg?branch=master)](https://travis-ci.org/nicolaspanel/grunt-contrib-django)

## Getting Started
This plugin requires Grunt `~0.4.0`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-contrib-django --save-dev
```

## Usage

### Basic gruntfile.js
```js
'use strict';

module.exports = function (grunt) {
    grunt.initConfig({
        'django-manage': {
            options: {
                app: 'myApp',
                // only if your 'manager.py' is on another path
                manage_path: './path/to/manage/'
            },
            serve: {
		options: {
                    command: 'runserver',
                    args: [],
                    background: true, // also accepts string/regexp
                    unBuffered: true // set python env to PYTHONUNBUFFERED=1 so STDOUT doesnt get buffered and grunt can read it
                    // NOTE: background setting also sets unBuffered to true by default
		    
		}
            },
            test: {
                options: {
                    command: 'test',
                    args: [
                        'myApp/tests',
                        '--pattern=test_*.py',
                        '--settings=myApp.settings.tests'
                    ]
                }
            },
            dump: {
                options: {
                    command: 'dumpdata',
                    args: [
                        '--format=json',
                        '--indent=4',
                        'myApp',                       // return only on application's models
                        '> ./path/to/output_file.json' // save in file
                    ]
                }
            }
        },
        'django-admin': {
            options: {
                app: 'myApp'
            },
            'compile': {
                options: {
                    command: 'compilemessages',
                    verbose: true // or 'errors' for STDERROR messages only
                }
            }
        }
    });

    grunt.registerTask('test', ['django-manage:test']);
    grunt.registerTask('compile', ['django-admin:compile']);
    grunt.registerTask('dump', ['django-manage:dump']);
    grunt.registerTask('default', ['test']);

    grunt.loadNpmTasks('grunt-contrib-django');
};
```

### Calling tasks
To run a `dumpdata` command you should run the following:

```shell
grunt dump // This will run 'python manage.py dumpdata --format=json --indent=4 myApp > ../path/to/output_file.json'
```
or
```shell
grunt django-manage:dump // which will also run 'python manage.py dumpdata --format=json --indent=4 myApp > ./path/to/output_file.json'
```


## License
[The MIT license](https://github.com/nicolaspanel/grunt-contrib-django/blob/master/License.txt)

---
_Source: https://npm.io/package/grunt-contrib-django · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._