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

  1. Clone your generated project
  2. Run the setup script (go.ps1 or go.sh)
  3. Activate the 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 analysis
  • Build verification and clean workspace checks
  • Package size limits

๐Ÿš€ Release Process

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


๐Ÿ•ถ

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.1.1.tar.gz (7.1 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.1.1-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: projay-1.1.1.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for projay-1.1.1.tar.gz
Algorithm Hash digest
SHA256 64727898c24fbfc8b5beb3b7a793fd385e2ccfaad99414cc5e36bd67014f92ed
MD5 4a5b23966bdee89ebda14411be330161
BLAKE2b-256 b456fa1729baac2371b8dfe771dfe55969c5e3a907b9d506acb954d4277ad81e

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: proJay-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.2 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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1259271cf529e4895f939585b3e175a1d71ee7f052e9b649e394337ba019bab3
MD5 3ca09cbcbe7e8e3cf3e7277ec2e5dbd0
BLAKE2b-256 66014dad5ac7e2319c3c404d0608a91c6bb5e7051ef332b3e659f557634e0787

See more details on using hashes here.

Provenance

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