A lightning-fast Python project generator with perfect GitHub workflows. Zero config, instant setup.
Project description
proJay
A lightning-fast Python project generator with perfect GitHub workflows. Zero config, instant setup.
๐ถ Features
- Ultra-Minimal: Single file, zero dependencies
- Instant Setup: One command to rule them all
- Perfect Structure: Production-ready in seconds
- GitHub Power: CI/CD, Release automation, Branch protection
- PyPI Ready: Configured for instant publishing
- Cross-Platform: Windows & Unix support with dedicated scripts
๐ Quick Start
python go.py your_project_name
# or
python go.py your_project_name --init-git
๐ด Generated Structure
your_project/
โโโ .github/
โ โโโ ISSUE_TEMPLATE/
โ โ โโโ bug_report.yml # Bug report template
โ โโโ workflows/
โ โ โโโ ci.yml # Multi-OS CI pipeline
โ โ โโโ release.yml # Automated PyPI releases
โ โโโ dependabot.yml # Daily updates
โ โโโ pull_request_template.md # PR template
โ โโโ settings.yml # Branch protection
โโโ main.py # Entry point
โโโ setup.py # PyPI configuration
โโโ requirements.txt # Dependencies
โโโ go.ps1/go.sh # Setup scripts
โโโ LICENSE # MIT License
โโโ README.md # Documentation
โโโ .gitignore # Clean workspace
๐ Scripts & Automation
-
Setup Scripts
- Windows:
go.ps1 - Unix:
go.sh - Automatic venv creation
- Dependencies installation
- Environment activation
- Windows:
-
CI Pipeline
- Multi-OS testing (Windows, Linux, MacOS)
- Python 3.8 to 3.13 support
- Dependencies verification
- Quality checks
- Clean build verification
-
DependaBot
- Daily pip updates
- GitHub Actions updates
- Automated PRs with labels
- Review assignments
- Grouped updates
-
Release Pipeline
- Version validation
- Package size checks
- PyPI publishing
- GitHub release creation
- Release notes generation
๐ Project Usage
# Generate project
python proJay.py my_project --init-git
# Setup environment
cd my_project
# On Windows
.\go.ps1
# On Unix
./go.sh
# Add remote & push
git remote add origin https://github.com/username/my_project
git push -u origin main
# Create release
git tag v0.1.0
git push origin v0.1.0
โก Development
- Clone your generated project
- Run the setup script (
go.ps1orgo.sh) - Activate virtual environment:
- Windows:
venv\Scripts\activate - Unix:
source venv/bin/activate
- Windows:
- Install dependencies:
pip install -r requirements.txt - Start coding in
main.py
๐ Continuous Integration
Automatic checks on every push:
- Cross-platform compatibility
- Python version compatibility
- Code quality
- Build verification
- Size limits
๐ Release Process
- Update version in
setup.py - Create and push tag
- Automatic:
- Package building
- Version validation
- Size verification
- PyPI publishing
- GitHub release
๐ต 46 6F 6C 6C 6F 77 20 74 68 65 20 77 68 69 74 65 20 72 61 62 62 69 74 ๐
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file projay-1.0.1.tar.gz.
File metadata
- Download URL: projay-1.0.1.tar.gz
- Upload date:
- Size: 6.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fc7a5501b7c4c265661acc06e228c2a6368d2230a0cfa674b7d6759755029d05
|
|
| MD5 |
5bea5622c26b94c41fe3dcf22d684a6b
|
|
| BLAKE2b-256 |
1595cd721885d979cbb28e27ef6925e405066533102179ebc115b6e476aebc3d
|
Provenance
The following attestation bundles were made for projay-1.0.1.tar.gz:
Publisher:
release.yml on FeelTheFonk/proJay
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
projay-1.0.1.tar.gz -
Subject digest:
fc7a5501b7c4c265661acc06e228c2a6368d2230a0cfa674b7d6759755029d05 - Sigstore transparency entry: 173502337
- Sigstore integration time:
-
Permalink:
FeelTheFonk/proJay@cb9e3a062d7028e02fcb6659eb14f76da49c567a -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/FeelTheFonk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@cb9e3a062d7028e02fcb6659eb14f76da49c567a -
Trigger Event:
push
-
Statement type:
File details
Details for the file proJay-1.0.1-py3-none-any.whl.
File metadata
- Download URL: proJay-1.0.1-py3-none-any.whl
- Upload date:
- Size: 7.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8bd20984e5585838b2202072ceee070083b10e34e33a0c94e2f6c8d00a4c75de
|
|
| MD5 |
38482bcc2229868628c6d260700d41b7
|
|
| BLAKE2b-256 |
caba5cb57da66338489b7d150f611251e650b9be33cb5a912ef6394176ae0f74
|
Provenance
The following attestation bundles were made for proJay-1.0.1-py3-none-any.whl:
Publisher:
release.yml on FeelTheFonk/proJay
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
projay-1.0.1-py3-none-any.whl -
Subject digest:
8bd20984e5585838b2202072ceee070083b10e34e33a0c94e2f6c8d00a4c75de - Sigstore transparency entry: 173502339
- Sigstore integration time:
-
Permalink:
FeelTheFonk/proJay@cb9e3a062d7028e02fcb6659eb14f76da49c567a -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/FeelTheFonk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@cb9e3a062d7028e02fcb6659eb14f76da49c567a -
Trigger Event:
push
-
Statement type: