Metadata-Version: 2.1
Name: dev-template
Version: 0.1.5
Summary: A module to generate a Python project template.
Home-page: https://github.com/http-kennedy/dev_template
Author: Kennedy
Author-email: kennedy@mylaptop.dev
License: CC0-1.0
Classifier: Programming Language :: Python :: 3
Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE

# dev_template

A module to quickly generate a basic Python project template.

## Features

* Creates a basic python project template
* Initalizes a virtual environment for the project
* Ability to add user-defined packages during setup
* Installs required (pydantic, pytest) and user defined packages into venv
* Standard Python .gitignore (also ignores _venv directory)
* Adds required (pydantic, pytest) and user defined packages to requirements.txt
* Imorts user defined packages during setup to src/main.py
* Prebuilds setup.py
* Prebuilds pyproject.toml

## Example Project Structure

```
project
├── project_venv
├── src
│   └── project
│       ├── __init__.py
│       └── main.py
├── tests
│   ├── __init__.py
│   └── test_main.py
├── .gitignore
├── README.md
├── requirements.txt
├── setup.py
└── pyproject.toml

```

## Installation

To install the package, use pip:

```bash
pip3 install dev-template
```

## Usage

Once installed type the following command into your terminal:

```bash
dev_template
```

or

```bash
python3 -m module.dev_template
```

Once project setup is done navigate into the project directory and type the following command to activate the venv:
* the folder that has the venv is named after your project. In this example we are using `project`

Linux
```bash
source project_venv/bin/activate
```

Powershell
```bash
.\project_venv\Scripts\Activate.ps1
```

To deactivate the venv type the following command into your terminal:

```bash
deactivate
```
