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.
|
||||||
+5
-1
@@ -16,5 +16,9 @@ try:
|
|||||||
except ImportError:
|
except ImportError:
|
||||||
from src.cli import run_cli
|
from src.cli import run_cli
|
||||||
|
|
||||||
if __name__ == "__main__":
|
def main() -> None:
|
||||||
sys.exit(run_cli())
|
sys.exit(run_cli())
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
|
|||||||
@@ -452,3 +452,8 @@ def run_cli(args: Optional[List[str]] = None) -> int:
|
|||||||
print(catalog.format("errors.unknown_command", command=command))
|
print(catalog.format("errors.unknown_command", command=command))
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> None:
|
||||||
|
"""Standard console_scripts entry point."""
|
||||||
|
sys.exit(run_cli())
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,50 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["setuptools>=61.0"]
|
||||||
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "gravitiny"
|
||||||
|
version = "0.1.0"
|
||||||
|
description = "Micro-Productivity Applet Ecosystem & Runtime Orchestrator"
|
||||||
|
readme = "README.md"
|
||||||
|
requires-python = ">=3.8"
|
||||||
|
license = { text = "MIT" }
|
||||||
|
authors = [
|
||||||
|
{ name = "Gravitiny Core Team", email = "admin@luxhebros.com" }
|
||||||
|
]
|
||||||
|
keywords = ["applet", "productivity", "orchestrator", "cli", "tools"]
|
||||||
|
classifiers = [
|
||||||
|
"Development Status :: 3 - Alpha",
|
||||||
|
"Environment :: Console",
|
||||||
|
"Intended Audience :: Developers",
|
||||||
|
"License :: OSI Approved :: MIT License",
|
||||||
|
"Operating System :: OS Independent",
|
||||||
|
"Programming Language :: Python :: 3",
|
||||||
|
"Programming Language :: Python :: 3.8",
|
||||||
|
"Programming Language :: Python :: 3.9",
|
||||||
|
"Programming Language :: Python :: 3.10",
|
||||||
|
"Programming Language :: Python :: 3.11",
|
||||||
|
"Programming Language :: Python :: 3.12",
|
||||||
|
"Programming Language :: Python :: 3.13",
|
||||||
|
"Topic :: Utilities",
|
||||||
|
]
|
||||||
|
dependencies = [
|
||||||
|
"requests>=2.28.0",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.urls]
|
||||||
|
Homepage = "https://git.luxhebros.com/admin/gravitiny"
|
||||||
|
Repository = "https://git.luxhebros.com/admin/gravitiny.git"
|
||||||
|
|
||||||
|
[project.scripts]
|
||||||
|
gravitiny = "gravitiny.src.cli:main"
|
||||||
|
|
||||||
|
[tool.setuptools.packages.find]
|
||||||
|
include = ["gravitiny", "gravitiny.*"]
|
||||||
|
|
||||||
|
[tool.setuptools.package-data]
|
||||||
|
gravitiny = [
|
||||||
|
"catalog/*.json",
|
||||||
|
"manifest.json",
|
||||||
|
"ISSUES.md",
|
||||||
|
]
|
||||||
Reference in New Issue
Block a user