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 -m go your_project_name

# or

python -m go 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.2.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.2-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file projay-1.0.2.tar.gz.

File metadata

  • Download URL: projay-1.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 d0c19b82653d0598c16a58df623d3f43586019a6da82a08f454c0b96c0a984c2
MD5 faef034eb0f1ac41d37e74f3142da3de
BLAKE2b-256 257244e0cdbf3fa776cdc854474cc336881ae6a2b226869fe8926c54f3ffcd1a

See more details on using hashes here.

Provenance

The following attestation bundles were made for projay-1.0.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: proJay-1.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ac5b5517bdcb95bf933f1530fcb364c0936f33551c98d0ddb90b1e9a3ab364b7
MD5 7f4815de9efd0611f44467901a10cead
BLAKE2b-256 4a7744ff9bcdb603d7ec8b83997b31256e613b4eb9b5dcd469dc6d429d80cb16

See more details on using hashes here.

Provenance

The following attestation bundles were made for proJay-1.0.2-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