https://github.com/isaac-cf-wong/ghnova
A Python package for interacting with the GitHub API, offering a simple interface to access repositories, users, organizations, issues, and more for automation and data management.
https://github.com/isaac-cf-wong/ghnova
api github
Last synced: 5 months ago
JSON representation
A Python package for interacting with the GitHub API, offering a simple interface to access repositories, users, organizations, issues, and more for automation and data management.
- Host: GitHub
- URL: https://github.com/isaac-cf-wong/ghnova
- Owner: isaac-cf-wong
- License: mit
- Created: 2026-01-17T16:12:53.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-01-18T13:47:16.000Z (5 months ago)
- Last Synced: 2026-01-18T20:44:53.098Z (5 months ago)
- Topics: api, github
- Language: Python
- Homepage: https://isaac-cf-wong.github.io/ghnova/
- Size: 130 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# ghnova
[](https://github.com/isaac-cf-wong/ghnova/actions/workflows/CI.yml)
[](https://results.pre-commit.ci/latest/github/isaac-cf-wong/ghnova/main)
[](https://isaac-cf-wong.github.io/ghnova/)
[](https://codecov.io/gh/isaac-cf-wong/ghnova)
[](https://pypi.org/project/ghnova/)
[](https://pypi.org/project/ghnova/)
[](LICENSE)
[](https://github.com/PyCQA/bandit)
[](https://doi.org/10.5281/zenodo.18290200)
**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](https://pypi.org/project/uv/) | [uv on GitHub](https://github.com/astral-sh/uv)
- Full documentation and usage guide: [uv docs](https://docs.astral.sh/uv/)
### Requirements
- Python 3.10 or higher
- Operating System: Linux, macOS, or Windows
### Install from PyPI
The recommended way to install `ghnova` is from PyPI:
```bash
# 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:
```bash
# 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:
```bash
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:
```bash
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:
```bash
ghnova --help
```
```bash
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](https://github.com/isaac-cf-wong/ghnova/releases).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Support
For questions, issues, or contributions, please:
- Check the [documentation](https://isaac-cf-wong.github.io/ghnova/)
- Open an issue on [GitHub](https://github.com/isaac-cf-wong/ghnova/issues)
- Join our [discussions](https://github.com/isaac-cf-wong/ghnova/discussions)
## Changelog
See [Release Notes](https://github.com/isaac-cf-wong/ghnova/releases) for version history.