ghnova

Note: This project is still in progress. The promised features are not fully ready yet, and APIs are subject to change.

A Python package for interacting with the GitHub API. This package provides a simple and intuitive interface to access GitHub repositories, users, organizations, issues, and more, enabling seamless integration with GitHub instances for automation, data retrieval, and management tasks.

Features

Full API Coverage: Access to repositories, users, organizations, issues, pull requests, and more.

• Easy Authentication: Support for token-based authentication.
• Asynchronous Support: Built with async/await for non-blocking operations.
• Type Hints: Full type annotations for better IDE support and code reliability.
• Comprehensive Documentation: Detailed guides and API reference.
• Command-Line Interface: Interact with the GitHub API directly from the terminal for quick, scriptable operations without writing code.

Installation

We recommend using uv to manage virtual environments for installing ghnova.

If you don't have uv installed, you can install it with pip. See the project pages for more details:

• Install via pip: pip install --upgrade pip && pip install uv
• Project pages: uv on PyPI | uv on GitHub
• Full documentation and usage guide: uv docs

Requirements

• Python 3.10 or higher
• Operating System: Linux, macOS, or Windows

Install from PyPI

The recommended way to install ghnova is from PyPI:

# Create a virtual environment (recommended with uv)
uv venv --python 3.10
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install ghnova

Optional Dependencies

For development or specific features:

# Development dependencies (testing, linting, etc.)
uv pip install ghnova[dev]

# Documentation dependencies
uv pip install ghnova[docs]

# All dependencies
uv pip install ghnova[dev,docs]

Install from Source

For the latest development version:

git clone git@github.com:isaac-cf-wong/ghnova.git
cd ghnova
# Create a virtual environment (recommended with uv)
uv venv --python 3.10
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install .

Development Installation

To set up for development:

git clone git@github.com:isaac-cf-wong/ghnova.git
cd ghnova

# Create a virtual environment (recommended with uv)
uv venv --python 3.10
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install ".[dev]"

# Install the commitlint dependencies
npm install

# Install pre-commit hooks
pre-commit install
pre-commit install --hook-type commit-msg

Verify Installation

Check that ghnova is installed correctly:

ghnova --help

python -c "import ghnova; print(ghnova.__version__)"

Release Schedule

Releases follow a fixed schedule: every Tuesday at 00:00 UTC, unless an emergent bugfix is required. This ensures predictable updates while allowing flexibility for critical issues. Users can view upcoming changes in the draft release on the GitHub Releases page.

License

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

Support

For questions, issues, or contributions, please:

• Check the documentation
• Open an issue on GitHub
• Join our discussions

Changelog

See Release Notes for version history.