A module to generate a Python project template.
Project description
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 Demo
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:
pip3 install dev-template
Usage
Once installed type the following command into your terminal:
dev_template
or
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
source project_venv/bin/activate
Powershell
.\project_venv\Scripts\Activate.ps1
To deactivate the venv type the following command into your terminal:
deactivate
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
dev_template-0.1.8.tar.gz
(8.4 kB
view hashes)
Built Distribution
Close
Hashes for dev_template-0.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05b89d7c3dfcc5eb87c622a089405eb765c8891cd7538cc2357c171d6427f027 |
|
MD5 | dd553573885d94e0ac7f4ea18f04eb46 |
|
BLAKE2b-256 | 2905d0052784becd3300bc4b070eeb3fc3a2735d26793d6698a3fbca23011dbf |