Metadata-Version: 2.1
Name: django-kick-off
Version: 0.0.2
Summary: Start a virtual environment and a fully configurated Django project with an app
Home-page: https://github.com/ignacio-nava/django-kick-off
Author: Ignacio Nava
Author-email: nava_ignacio@outlook.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Topic :: Software Development
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Requires-Dist: pytest (>=3.6) ; extra == 'dev'
Requires-Dist: check-manifest ; extra == 'dev'

# Kick-Off-Django

The idea of this package is to avoid the repetitive task of configuring a Django project and virtual environment.  


## Installation

```python
pip install kick-off-django
```

## Usage

```python
python3 -m kick_off <project_name> <venv_name>
```
OUTPUT:
- requirements.txt
- virtual environment
- Django project with an app.

## Example #1 (Generic Naming)

```python
python3 -m kick_off
```

OUTPUT:
```bash
|--requirements.txt
|--venvMySite/
    |--bin/
    |--include/
    |--lib/
    |--pyvenv.cfg
|--mysite/
    |--home/
    |--mysite/
    |--manage.py
    |--db.sqlite3
```

## Example #2 (Only Project Naming)

```python
python3 -m kick_off test_web
```

OUTPUT:
```bash
|--requirements.txt
|--venvTestWeb/
    |--bin/
    |--include/
    |--lib/
    |--pyvenv.cfg
|--test_web/
    |--home/
    |--test_web/
    |--manage.py
    |--db.sqlite3
```

## Example #3 (Project and Venv Naming)

```python
python3 -m kick_off test_web Example
```

OUTPUT:
```bash
|--requirements.txt
|--venvExample/
    |--bin/
    |--include/
    |--lib/
    |--pyvenv.cfg
|--test_web/
    |--home/
    |--test_web/
    |--manage.py
    |--db.sqlite3
```

