Standardized setup.py
Overview
This project contains a Python-based setup automation tool designed to help streamline the process of preparing and managing project setups. It includes utilities for handling versioning, dates, notes, and README files, leveraging a dynamic caching system to maintain state across sessions.
Word of Caution
:warning: This project is still in development and should be used with caution. :warning:
Planned Features
- Date Management: Automatically manages the date of the last modification using a custom class.
- Version Control: Validates and stores version numbers with a strict format.
- Notes Management: Supports capturing and formatting release notes for easy inclusion in project documentation.
- Automated Setup: Integrates with
setuptoolsfor seamless package distribution preparation.
Requirements
- Python 3.x
setuptoolsmodule
Usage
- Initialization: Start by configuring the basic project parameters like name, version, and description.
- Parameter Management: Through interactive prompts, manage various parameters including version number, modification dates, and release notes.
- Setup Execution: Execute the setup to generate distribution packages and, optionally, publish them to PyPi.
Example
from templated_setup import Setup_Helper
DESCRIPTION = "A quick and easy replacement for some `setup.py` implementations."
Setup_Helper.setup(
name="templated_setup",
author="matrikater (Joel Watson)",
description=DESCRIPTION,
author_email="administraitor@matriko.xyz",
)
Installation
To install the package, run the following command:
pip install templated-setup
Contributing
Contributions are welcome! For feature requests, bug reports, or questions, please submit an issue.
Actually I would be happy to have some help with this project as making a
setup.pyevery time is a bit boring.
License
This project is licensed under the GPLv2 License - see the LICENSE file for details.
V0.9991
No notes.
Release files for templated-setup 0.9991
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| templated_setup-0.9991.tar.gz | 17.8 kB | Details |
Release files / templated_setup-0.9991.tar.gz
| Download URL | templated_setup-0.9991.tar.gz |
|---|---|
| Size | 17.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
439919e186923960a5518ca2eccadddfbc0bee3f2d83a5f8e3d2c45deef9265d
|
|
BLAKE2b-256 checksum How to use checksums |
39d60269dd907009f9b849e15d102afe5ac1332d5f5c99469095a49c833f6e6f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|