diff --git a/README.md b/README.md new file mode 100644 index 0000000..cf405be --- /dev/null +++ b/README.md @@ -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 + +# Install an applet from registry or Git URL +gravitiny install + +# List all installed applets and shims +gravitiny list + +# Run an applet through Gravitiny +gravitiny run [args...] + +# Shorthand execution +gravitiny [args...] + +# Display detailed metadata for an applet +gravitiny info + +# Remove an installed applet and its shims +gravitiny remove + +# 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. diff --git a/gravitiny/main.py b/gravitiny/main.py index 58c49b1..f7132fd 100644 --- a/gravitiny/main.py +++ b/gravitiny/main.py @@ -16,5 +16,9 @@ try: except ImportError: from src.cli import run_cli -if __name__ == "__main__": +def main() -> None: sys.exit(run_cli()) + + +if __name__ == "__main__": + main() diff --git a/gravitiny/src/cli.py b/gravitiny/src/cli.py index 169de2a..d193c48 100644 --- a/gravitiny/src/cli.py +++ b/gravitiny/src/cli.py @@ -452,3 +452,8 @@ def run_cli(args: Optional[List[str]] = None) -> int: print(catalog.format("errors.unknown_command", command=command)) return 1 + +def main() -> None: + """Standard console_scripts entry point.""" + sys.exit(run_cli()) + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..8f54af8 --- /dev/null +++ b/pyproject.toml @@ -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", +]