<commit_before>Django Bootstra.386 Boilerplate
===========================

Django Bootstra.386 template project with class view feature, based on the BOOTSRA.386 project

Current stable version: 0.0.1

## Introduction

This project makes you to create a simple django project with Bootstra.386 with minimal effort and with some common utils
for you project.

### Features

* Class oriented views.
* Simple Project creation with a single command line.
* Base classes for views, models and services with common methods for simpler usage of project classes.

## Instalation

Installing Django Bootstrap is pretty straight forward, but some requirements must be made to be able to use this project:

Python 2.7

> **note**
>
> For future versions, the project will be Python 3.3+ compatible.

Some more requirements are also needed but are resolved on installed via pip, with the following command:

```python
pip install django-classview-bootstrap3
```

If you're installing with the targ.gz or zip distribution, you'll need to have these requirements installed in your python enviroment:

* django >= 1.6
* django_conventions
* django-webtest
* south
* dj_database_url
* simplejson

you can get them with the following command, after you have the project uncompressed:

```python
pip install -r requirements.txt
```

## Creating a project

Creating a project is pretty simple, just issue the following command on your shell:



```python
$ create_bootstrap_project <your_project_name>
```

This command will create a project with the name passed as parameter. If no name has been issued with the command, expect
the following output with this error:

![IMAGE](https://raw.github.com/bossiernesto/django-bootstra386-classview/master/django_bootstrap3view/doc/images/no_project_name.png)

If the name of the project exists as a directory where you're issuing the command, expect the following output:

![IMAGE](https://raw.github.com/bossiernesto/django-bootstra386-classview/master/django_bootstrap3view/doc/images/existing_project_name.png)

Otherwise the project will be created as follows (using testapp as the project name):

![IMAGE](https://raw.github.com/bossiernesto/django-bootstra386-classview/master/django_bootstrap3view/doc/images/correct_project_name.png)

## Base Model and extension

The boilerplate project comes with a Base Model class, with the following structure:

```python
class BaseEntity(models.Model):
<commit_msg>fix readme<commit_after>Django Bootstra.386 Boilerplate
===========================

Django Bootstra.386 template project with class view feature, based on the BOOTSRA.386 project

Current stable version: 0.0.1

## Introduction

This project makes you to create a simple django project with Bootstra.386 with minimal effort and with some common utils
for you project.

### Features

* Class oriented views.
* Simple Project creation with a single command line.
* Base classes for views, models and services with common methods for simpler usage of project classes.

## Instalation

Installing Django Bootstrap is pretty straight forward, but some requirements must be made to be able to use this project:

Python 2.7

> **note**
>
> For future versions, the project will be Python 3.3+ compatible.

Some more requirements are also needed but are resolved on installed via pip, with the following command:

```python
pip install django-classview-bootstrap3
```

If you're installing with the targ.gz or zip distribution, you'll need to have these requirements installed in your python enviroment:

* django >= 1.6
* django_conventions
* django-webtest
* south
* dj_database_url
* simplejson

you can get them with the following command, after you have the project uncompressed:

```python
pip install -r requirements.txt
```

## Creating a project

Creating a project is pretty simple, just issue the following command on your shell:



```python
$ create_bootstrap_project <your_project_name>
```

This command will create a project with the name passed as parameter. If no name has been issued with the command, expect
the following output with this error:

![IMAGE](https://raw.github.com/bossiernesto/django-bootstra386-classview/master/django_bootstrap386view/doc/images/no_project_name.png)

If the name of the project exists as a directory where you're issuing the command, expect the following output:

![IMAGE](https://raw.github.com/bossiernesto/django-bootstra386-classview/master/django_bootstra386view/doc/images/existing_project_name.png)

Otherwise the project will be created as follows (using testapp as the project name):

![IMAGE](https://raw.github.com/bossiernesto/django-bootstra386-classview/master/django_bootstrap386view/doc/images/correct_project_name.png)

## Base Model and extension

The boilerplate project comes with a Base Model class, with the following structure:

```python
class BaseEntity(models.Model):

{'fraction_non_alphanumeric': 0.07995079950799508, 'fraction_numerical': 0.015170151701517014, 'mean_word_length': 5.175949367088608, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 13, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5273573', 'n_tokens_mistral': 1370, 'n_tokens_neox': 1267, 'n_words': 555}