Skip to main content

A lightning-fast Python project generator with perfect GitHub workflows. Zero config, instant setup.

Project description

proJay

PyPI version CI License: MIT

TheMatrixReloadedNeoGIF

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
  • 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

  1. Clone your generated project
  2. Run the setup script (go.ps1 or go.sh)
  3. Activate virtual environment:
    • Windows: venv\Scripts\activate
    • Unix: source venv/bin/activate
  4. Install dependencies: pip install -r requirements.txt
  5. 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

  1. Update version in setup.py
  2. Create and push tag
  3. 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

projay-1.0.1.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

proJay-1.0.1-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

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

Hashes for projay-1.0.1.tar.gz
Algorithm Hash digest
SHA256 fc7a5501b7c4c265661acc06e228c2a6368d2230a0cfa674b7d6759755029d05
MD5 5bea5622c26b94c41fe3dcf22d684a6b
BLAKE2b-256 1595cd721885d979cbb28e27ef6925e405066533102179ebc115b6e476aebc3d

See more details on using hashes here.

Provenance

The following attestation bundles were made for projay-1.0.1.tar.gz:

Publisher: release.yml on FeelTheFonk/proJay

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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

Hashes for proJay-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8bd20984e5585838b2202072ceee070083b10e34e33a0c94e2f6c8d00a4c75de
MD5 38482bcc2229868628c6d260700d41b7
BLAKE2b-256 caba5cb57da66338489b7d150f611251e650b9be33cb5a912ef6394176ae0f74

See more details on using hashes here.

Provenance

The following attestation bundles were made for proJay-1.0.1-py3-none-any.whl:

Publisher: release.yml on FeelTheFonk/proJay

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page