Skip to main content

A short description

Project description

Pocus - PHP Package Installer and Runner

Pocus is a Python tool that simplifies PHP package management and execution. It automatically detects and installs the required PHP version based on composer.json requirements, downloads PHP packages, and provides an easy way to run bin scripts and PHP files.

Features

  • Automatic PHP Version Management: Detects required PHP version from composer.json and installs it
  • Package Installation: Installs PHP packages using Composer
  • Bin Script Execution: Runs bin scripts from installed packages
  • GitHub Repository Support: Downloads and installs packages directly from GitHub URLs
  • PHP File Execution: Runs PHP files using the installed PHP version
  • Cross-Platform: Works on macOS, Linux, and Windows
  • Multiple Architecture Support: Supports x86_64, arm64, and more

Installation

# Clone the repository
git clone https://github.com/pronskiy/pocus.git
cd pocus

# Install as a Python package (optional)
pip install -e .

Usage

Basic Usage

# Install a package and its dependencies
python -m pocus phpstan/phpstan

# Run a bin script from an installed package
python -m pocus phpstan/phpstan phpstan analyse path/to/code

# Run a PHP file using the installed PHP version
python -m pocus phpstan/phpstan script.php arg1 arg2

Installing from GitHub

# Install a package directly from GitHub
python -m pocus https://github.com/phpstan/phpstan

Version Constraints

Pocus supports various version constraints in composer.json:

{
    "require": {
        "php": "^7.4|^8.0"  // Will use PHP 8.0
    }
}

How It Works

  1. Pocus reads the PHP version requirement from composer.json
  2. It normalizes the PHP version to match available versions
  3. It downloads the appropriate PHP binary if it doesn't already exist
  4. It stores the PHP binary in ~/.pocus/{version}/
  5. It installs the requested package using Composer
  6. It executes bin scripts or PHP files as requested

Directory Structure

~/.pocus/
  ├── downloads/       # Temporary storage for downloaded archives
  └── {version}/       # Extracted PHP binaries for each version
      └── php          # PHP binary executable

Requirements

  • Python 3.6+
  • Internet connection for downloading PHP binaries and packages

Contributing

Contributions are welcome! Feel free to submit issues or pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

pocus-0.1.0.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

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

pocus-0.1.0-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file pocus-0.1.0.tar.gz.

File metadata

  • Download URL: pocus-0.1.0.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.10

File hashes

Hashes for pocus-0.1.0.tar.gz
Algorithm Hash digest
SHA256 33b98880374b3c2cd7dd26b659475bd2d6a87e1b8bc9483dfe1739b65efa08d7
MD5 9495f4710ef289abd35bce82a44bcf7a
BLAKE2b-256 1492feb874427cb490dc863dc4a901aa1a79d32b85408fc81e99b6b0a9fb6fda

See more details on using hashes here.

File details

Details for the file pocus-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pocus-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.10

File hashes

Hashes for pocus-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a9613aef435c3d07214c4923e14c28bba2c9d66e908ba1643920215d9941dfc
MD5 0bb211d6164047efca0f4ea6f766f5f6
BLAKE2b-256 2a394fbb07aace534a352324314ec140ab46c8d8e431300b89aab36e12f1e883

See more details on using hashes here.

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