feat(packaging): add pyproject.toml and console_scripts entrypoint for pip distribution
This commit is contained in:
@@ -0,0 +1,70 @@
|
||||
# Gravitiny Core
|
||||
|
||||
Micro-Productivity Applet Ecosystem & Runtime Orchestrator.
|
||||
|
||||
Gravitiny is a minimalist, ultra-fast command-line runner and micro-package manager designed for single-purpose developer utilities and productivity tools.
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
### Method 1: Using pip (Recommended)
|
||||
|
||||
Install directly from the remote Git repository into your Python environment:
|
||||
|
||||
```bash
|
||||
pip install git+https://git.luxhebros.com/admin/gravitiny.git
|
||||
```
|
||||
|
||||
### Method 2: Standalone Zero-Trace Installer
|
||||
|
||||
Clone the repository and run the standalone installer, which sets up Gravitiny under `~/.gravitiny` and configures your system PATH without needing Python packaging tools:
|
||||
|
||||
```bash
|
||||
git clone https://git.luxhebros.com/admin/gravitiny.git
|
||||
cd gravitiny
|
||||
python install.py
|
||||
```
|
||||
|
||||
After installation finishes, you may safely delete the cloned directory.
|
||||
|
||||
---
|
||||
|
||||
## Quickstart & Commands
|
||||
|
||||
```bash
|
||||
# Search available applets in the central registry
|
||||
gravitiny search <query>
|
||||
|
||||
# Install an applet from registry or Git URL
|
||||
gravitiny install <applet_id | git_url>
|
||||
|
||||
# List all installed applets and shims
|
||||
gravitiny list
|
||||
|
||||
# Run an applet through Gravitiny
|
||||
gravitiny run <applet_id> [args...]
|
||||
|
||||
# Shorthand execution
|
||||
gravitiny <applet_id> [args...]
|
||||
|
||||
# Display detailed metadata for an applet
|
||||
gravitiny info <applet_id>
|
||||
|
||||
# Remove an installed applet and its shims
|
||||
gravitiny remove <applet_id>
|
||||
|
||||
# Initialize environment and configure system PATH
|
||||
gravitiny setup
|
||||
|
||||
# Completely remove Gravitiny, applets, and system PATH registration
|
||||
gravitiny uninstall -y
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Architecture & License
|
||||
|
||||
- **Cross-Platform Shims:** Generates zero-overhead `.cmd` wrappers on Windows and POSIX shell scripts on Linux/macOS.
|
||||
- **Dual Discovery:** Discovers workspace-local applets and user-space applets seamlessly.
|
||||
- **License:** MIT License.
|
||||
Reference in New Issue
Block a user