<commit_before># Django Mogo

Starter kit for Django projects. Installs a ready to use Django environment with utility modules and
templates, autogenerating a settings file.

## What you get

- A ready to use Django environnement with a complete set of utilities and templates
- A websockets ready solution with [Django Instant](https://github.com/synw/django-instant)

## Requirements

Virtualenv, pip, git and the necessary packages to install Pillow

## Install

Note you will need virtualenv, git and a few libs installed on your system before to install, such as the ones required
for Pillow.

  ```bash
git clone https://github.com/synw/django-mogo.git
# copy django-mogo/djangomogo to a dir where you want your virtual env and the django project to be installed
# do not set a virtualenv: Mogo will do it for you
python3 djangomogo
  ```

Tweak the autogenerated `settings.py` to fit your needs.

### Install options

The base installer will setup Django with a bunch of modules. The following install options are available

Django only:

   ```bash
python3 djangomogo -django
   ```

Do not install and configure Django, just install modules:

   ```bash
python3 djangomogo -modules
   ```
   
Install monitoring tools:

   ```bash
python3 djangomogo -mon
   ```
   
Do not set any virtualenv:
   
   ```bash
python3 djangomogo -noenv
   ```
   
Install the developement modules: pytest, coverage and the Grunt assets pipeline (npm is required):

   ```bash
python3 djangomogo -dev
   ```

## Applications list

This quick start kit installs the following Django modules:

#### Image processing

- [pillow](https://github.com/python-pillow/Pillow): standard image processing lib
- [easy-thumbnails](https://github.com/SmileyChris/easy-thumbnails): generate thumbnails using cache

#### Authentication

- [django-allauth](https://github.com/pennersr/django-allauth) for authentication with social networks

#### Text editors

- [django-ckeditor](https://github.com/django-ckeditor/django-ckeditor): wysywig text editor
- [django-codemirror2](https://github.com/sk1p/django-codemirror2): code editor

#### Content management

- [django-sfp](https://github.com/synw/django-sfp) for pages management
- [django-dirtyedit](https://github.com/synw/django-dirtyedit) for editing files from the admin
- [django-qcf](https://github.com/synw/django-qcf): contact form

#### Utilities

- [ipython](http://ipython.org/) : powerfull python shell integrated with Django
- [django-compressor](https://github.com/django-compressor/django-compressor): to compress static assets
- [django-reversion](https://github.com/etianen/django-reversion) for version control
- [django-mptt](https://github.com/django-mptt/django-mptt): utility for working with trees
- [django-braces](https://github.com/brack3t/django-braces): usefull mixins
- [django-extensions](https://github.com/django-extensions/django-extensions) : usefull tools
- [django-mqueue](https://github.com/synw/django-mqueue): for logging app events 
- [django-filebrowser-no-grappelli](https://github.com/smacker/django-filebrowser-no-grappelli): files management

#### Websockets (optional)

- [Centrifugo](https://github.com/centrifugal/centrifugo/): the websockets server
- [django-instant](https://github.com/synw/django-instant): Centrifugo <-> Django layer
- [django-autoreloader](https://github.com/synw/django-autoreloader) for hot reload during development

#### Monitoring (optional)

- [django-watchtower](https://github.com/synw/django-watchtower): to collect metrics and events

#### Developement (optional)

- [django-debug-toolbar](https://github.com/django-debug-toolbar/django-debug-toolbar) for apps debug
- [pytest-django](https://github.com/pytest-dev/pytest-django): test suite
- [pytest-cov](https://github.com/pytest-dev/pytest-cov): coverage for pytest
- [coverage](https://bitbucket.org/ned/coveragepy): utility for test coverage reporting
- [django-autofixture](https://github.com/gregmuellegger/django-autofixture): for generating test data

#### Templates

Batteries are included with a base template set using [Bulma](http://bulma.io/) for the css

#### What is that name?

In west african french slang a mogo is a man (and a go is a girl). So it means "django guy"

<commit_msg>Format readme<commit_after># Django Mogo

Starter kit for Django projects. Installs a ready to use Django environment with utility modules and
templates, autogenerating a settings file.

## What you get

- A ready to use Django environnement with a complete set of utilities and templates
- A websockets ready solution with [Django Instant](https://github.com/synw/django-instant)

## Requirements

Virtualenv, pip, git and the necessary packages to install Pillow

## Install

Note you will need virtualenv, git and a few libs installed on your system before to install, such as the ones required
for Pillow.

  ```bash
git clone https://github.com/synw/django-mogo.git
# copy django-mogo/djangomogo to a dir where you want your virtual env and the django project to be installed
# do not set a virtualenv: Mogo will do it for you
python3 djangomogo
  ```

Tweak the autogenerated `settings.py` to fit your needs.

### Install options

The base installer will setup Django with a bunch of modules. The following install options are available

Django only:

   ```bash
python3 djangomogo -django
   ```

Do not install and configure Django, just install modules:

   ```bash
python3 djangomogo -modules
   ```
   
Install monitoring tools:

   ```bash
python3 djangomogo -mon
   ```
   
Do not set any virtualenv:
   
   ```bash
python3 djangomogo -noenv
   ```
   
Install the developement modules: pytest, coverage and the Grunt assets pipeline (npm is required):

   ```bash
python3 djangomogo -dev
   ```

## Applications list

This quick start kit installs the following Django modules:

#### Image processing

- [pillow](https://github.com/python-pillow/Pillow): standard image processing lib
- [easy-thumbnails](https://github.com/SmileyChris/easy-thumbnails): generate thumbnails using cache

#### Authentication

- [django-allauth](https://github.com/pennersr/django-allauth) for authentication with social networks

#### Text editors

- [django-ckeditor](https://github.com/django-ckeditor/django-ckeditor): wysywig text editor
- [django-codemirror2](https://github.com/sk1p/django-codemirror2): code editor

#### Content management

- [django-sfp](https://github.com/synw/django-sfp) for pages management
- [django-dirtyedit](https://github.com/synw/django-dirtyedit) for editing files from the admin
- [django-qcf](https://github.com/synw/django-qcf): contact form

#### Utilities

- [ipython](http://ipython.org/) : powerfull python shell integrated with Django
- [django-compressor](https://github.com/django-compressor/django-compressor): to compress static assets
- [django-reversion](https://github.com/etianen/django-reversion) for version control
- [django-mptt](https://github.com/django-mptt/django-mptt): utility for working with trees
- [django-braces](https://github.com/brack3t/django-braces): usefull mixins
- [django-extensions](https://github.com/django-extensions/django-extensions) : usefull tools
- [django-mqueue](https://github.com/synw/django-mqueue): for logging app events 
- [django-filebrowser-no-grappelli](https://github.com/smacker/django-filebrowser-no-grappelli): files management

#### Websockets (optional)

- [Centrifugo](https://github.com/centrifugal/centrifugo/): the websockets server
- [django-instant](https://github.com/synw/django-instant): Centrifugo <-> Django layer
- [django-autoreloader](https://github.com/synw/django-autoreloader) for hot reload during development

#### Monitoring (optional)

- [django-watchtower](https://github.com/synw/django-watchtower): to collect metrics and events

#### Developement (optional)

- [django-debug-toolbar](https://github.com/django-debug-toolbar/django-debug-toolbar) for apps debug
- [pytest-django](https://github.com/pytest-dev/pytest-django): test suite
- [pytest-cov](https://github.com/pytest-dev/pytest-cov): coverage for pytest
- [coverage](https://bitbucket.org/ned/coveragepy): utility for test coverage reporting
- [django-autofixture](https://github.com/gregmuellegger/django-autofixture): for generating test data

## Templates

Batteries are included with a base template set using [Bulma](http://bulma.io/) for the css

## What is that name?

In west african french slang a mogo is a man (and a go is a girl). So it means "django guy"


{'fraction_non_alphanumeric': 0.12200282087447109, 'fraction_numerical': 0.0023507287259050304, 'mean_word_length': 4.568717277486911, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 52, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1608663', 'n_tokens_mistral': 2631, 'n_tokens_neox': 2555, 'n_words': 757}