# generator-django-ana

> Generate Django boilerplate.

Latest version **0.2.2** (published 2017-05-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-django-ana
pnpm add generator-django-ana
yarn add generator-django-ana
bun add generator-django-ana
```

## 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.2.2 |
| Published | 2017-05-24 |
| First published | 2016-12-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Wtower |
| Maintainers | wtower |
| Keywords | yeoman-generator |

## Links

- npm: https://www.npmjs.com/package/generator-django-ana
- Repository: https://github.com/Wtower/generator-django-ana
- Homepage: https://github.com/Wtower/generator-django-ana.git
- Issues: https://github.com/Wtower/generator-django-ana/issues
- npm.io page: https://npm.io/package/generator-django-ana

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^1.0.0
- [yosay](https://npm.io/package/yosay.md) ^2.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.2
- [randomstring](https://npm.io/package/randomstring.md) ^1.1.5
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^0.24.1

## Recent versions

- 0.2.2 (latest) — 2017-05-24
- 0.2.1 — 2017-04-05
- 0.2.0 — 2017-04-04
- 0.1.9 — 2017-03-02
- 0.1.8 — 2017-02-17
- 0.1.7 — 2017-01-24
- 0.1.6 — 2017-01-13
- 0.1.5 — 2017-01-08
- 0.1.4 — 2017-01-03
- 0.1.3 — 2016-12-25
- 0.1.1 — 2016-12-13
- 0.1.0 — 2016-12-12

## README

generator-django-ana 
====================

[![NPM version][npm-image]][npm-url] 
[![Build Status][travis-image]][travis-url] 
[![Coverage percentage][coveralls-image]][coveralls-url]
[![npm](https://img.shields.io/npm/dt/generator-django-ana.svg?maxAge=2592000)](https://www.npmjs.com/package/generator-django-ana)

[npm-image]: https://badge.fury.io/js/generator-django-ana.svg
[npm-url]: https://npmjs.org/package/generator-django-ana
[travis-image]: https://travis-ci.org/Wtower/generator-django-ana.svg?branch=master
[travis-url]: https://travis-ci.org/Wtower/generator-django-ana
[coveralls-image]: https://coveralls.io/repos/Wtower/generator-django-ana/badge.svg
[coveralls-url]: https://coveralls.io/r/Wtower/generator-django-ana

Generate Django boilerplate

Features
--------

The default [django-admin startproject](https://docs.djangoproject.com/en/1.10/ref/django-admin/#startproject)
is quite simple. You can provide template for the generated code to replace the 
[default](https://github.com/django/django/tree/master/django/conf/project_template) like in this 
[example](https://www.maykinmedia.nl/blog/2013/jun/6/customizing-django-startproject-templates/),
but it does not any of the following features:

- [Additional configuration parameters](http://stackoverflow.com/questions/41413448/when-starting-a-new-django-project-via-django-admin-py-is-there-a-way-to-inject/41414672#41414672)
- Save configuration to disk
- Re-run the generator

Installation
------------

First, install [Yeoman](http://yeoman.io) and generator-django-ana using [npm](https://www.npmjs.com/) 
(we assume you have pre-installed [node.js](https://nodejs.org/)).

```bash
npm install -g yo
npm install -g generator-django-ana
```

Then generate your new project:

```bash
yo django-ana
```

Description
-----------

The generator creates a new project with:

- A default `requirements.txt` with most useful Django packages.
- A default `package.json` file with the appropriate description and dependencies for front-end management.
- Default meta documents: `README`, private `LICENSE`, `CONTRIBUTING`, `CHANGELOG`.
- Default `.gitignore` and `.editorconfig` files.
- A standard Django `manage.py` script.
- A default `gulpfile.js` for managing front-end.
- A `newrelic.ini` configuration file for Python.
- The main application python package with settings for development, testing and production, wsgi and mod_wsgi scripts
  and main urls routes.
- An additional 'core' python package for specifying application information, use signals and template tags.
- Default media, private and templates directories.
- A `.yo-rc.json` local yeoman configuration file with the options used to generate the project.

Prompts
-------

The generator prompts for the following information:

- Project name: the generated project name (snake case).
  Used in: `README.md, package.json, manage.py, gulpfile.js, _venv`, 
  `_name_/ settings*.py, urls.py, wsgi.py, wsgi_mod.py`,
  `_name__core/apps.py`.
  
- Pascal name: the generated project name (pascal case).
  Used in: `_name__core/ apps.py, tests.py`.
  
- Verbose name: a verbose project name, spaces allowed.
  Used in: `_name_/settings.py, _name__core/apps.py`.

- Description: project description.
  Used in: `README.md, package.json, _name_/settings.py`.

- Git repository URL. Used in `package.json`.

- Author. Used in `package.json, LICENSE, CONTRIBUTING.md`.

- Deploy host: optional for `npm deploy` command.
  Used in: `package.json`.

- Allowed host: Used in: `_name_/ settings_live.py, wsgi_mod.py`.

- New Relic license key. Used in `newrelic.ini`.

After generation
----------------

Usually perform the following actions:

```
vf new -p python3 VIRTUALENV
pip install -U pip setuptools wheel
pip install -U -r requirements.txt
./manage.py migrate
./manage.py createsuperuser
```

Useful links
------------

- https://github.com/django/django/tree/master/django/conf/project_template

License
-------

MIT © [Wtower](https://github.com/Wtower)

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