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
- Optimized Build: Automatic source minification during the release process to reduce package size without impacting runtime
💊 Quick Start
pip install proJay
python -m go your_project_name
🔴 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 with minification
│ ├── 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 virtual environment 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 and clean build verification
-
DependaBot
- Daily pip updates
- GitHub Actions updates
- Automated PRs with labels
- Review assignments
- Grouped updates
-
Release Pipeline
- Version validation
- Code minification (appliquée automatiquement lors du build pour optimiser le code source)
- Package size checks
- PyPI publishing
- GitHub release creation with auto-generated release notes
📂 Project Usage
# Generate project
python -m go 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 the 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 analysis
- Build verification and clean workspace checks
- Package size limits
🚀 Release Process
- Update version in
setup.py - Create and push tag
- Automatic steps:
- Code Minification: The source code is minified during the release build process
- Package building
- Version validation
- Size verification
- PyPI publishing
- GitHub release creation with auto-generated release notes
🔵 46 6F 6C 6C 6F 77 20 74 68 65 20 77 68 69 74 65 20 72 61 62 62 69 74 🐇
Metadata
Release files for proJay 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| projay-1.1.1.tar.gz | 7.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| proJay-1.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.3 kB
Release files / projay-1.1.1.tar.gz
| Download URL | projay-1.1.1.tar.gz |
|---|---|
| Size | 7.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
64727898c24fbfc8b5beb3b7a793fd385e2ccfaad99414cc5e36bd67014f92ed
|
|
BLAKE2b-256 checksum How to use checksums |
b456fa1729baac2371b8dfe771dfe55969c5e3a907b9d506acb954d4277ad81e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 22, 2025.
Transparency logRelease files / proJay-1.1.1-py3-none-any.whl
| Download URL | proJay-1.1.1-py3-none-any.whl |
|---|---|
| Size | 8.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1259271cf529e4895f939585b3e175a1d71ee7f052e9b649e394337ba019bab3
|
|
BLAKE2b-256 checksum How to use checksums |
66014dad5ac7e2319c3c404d0608a91c6bb5e7051ef332b3e659f557634e0787
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 22, 2025.
Transparency log