Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frgfm/ghapi
Python wrapper for the GitHub API
https://github.com/frgfm/ghapi
github-api python-client
Last synced: 18 days ago
JSON representation
Python wrapper for the GitHub API
- Host: GitHub
- URL: https://github.com/frgfm/ghapi
- Owner: frgfm
- License: apache-2.0
- Created: 2022-12-19T20:52:23.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T21:44:18.000Z (2 months ago)
- Last Synced: 2024-10-23T04:20:05.287Z (23 days ago)
- Topics: github-api, python-client
- Language: Python
- Homepage: https://frgfm.github.io/ghapi
- Size: 541 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Python client for GitHub API
## Quick Tour
### Interacting with Pull Request
This project uses [GitHub API](https://docs.github.com/en/rest) to fetch information from GitHub using a Python wrapper.
You can find the exhaustive list of supported features in the [documentation](https://frgfm.github.io/ghapi). For instance, you can retrieve basic information about your pull request as follows:
```python
from ghapi.pulls import Repository, PullRequest
pr = PullRequest(Repository("frgfm", "torch-cam"), 187)
# Get the PR information
pr.get_info()
```
```
{'title': 'fix: Fixed zero division for weight computation in gradient based methods',
'created_at': '2022-09-18T17:08:50Z',
'description': 'This PR introduces an `eps` to all divisions in gradient methods to avoid NaNs.\r\n\r\nCloses #186',
'labels': [{'id': 1929545961,
'node_id': 'MDU6TGFiZWwxOTI5NTQ1OTYx',
'url': 'https://api.github.com/repos/frgfm/torch-cam/labels/type:%20bug',
'name': 'type: bug',
'color': 'd73a4a',
'default': False,
'description': "Something isn't working"},
{'id': 1929975543,
'node_id': 'MDU6TGFiZWwxOTI5OTc1NTQz',
'url': 'https://api.github.com/repos/frgfm/torch-cam/labels/ext:%20tests',
'name': 'ext: tests',
'color': 'f7e101',
'default': False,
'description': 'Related to test'},
{'id': 1929975788,
'node_id': 'MDU6TGFiZWwxOTI5OTc1Nzg4',
'url': 'https://api.github.com/repos/frgfm/torch-cam/labels/module:%20methods',
'name': 'module: methods',
'color': 'f7e101',
'default': False,
'description': 'Related to torchcam.methods'}],
'user': 'frgfm',
'mergeable': None,
'changed_files': 3,
'additions': 15,
'deletions': 8,
'base': {'branch': 'main', 'sha': '0a5e06051440e27de6027ec382517a2c71686298'},
'head': {'repo': 'frgfm/torch-cam',
'branch': 'grad-nans',
'sha': 'd49f4a3d847e130e99c3d20311e1450f074fd29f'}}
```
If you're interested in reviewing the pull request, you might be interested in the code diff:
```python
# Retrieve the code diff
full_diff = pr.get_diff()
# Print the first diff section
print(full_diff["torchcam/methods/gradient.py"][0]["text"])
```
which yields:
```
- def _get_weights(self, class_idx: Union[int, List[int]], scores: Tensor, **kwargs: Any) -> List[Tensor]:
+ def _get_weights(
+ self, class_idx: Union[int, List[int]], scores: Tensor, eps: float = 1e-8, **kwargs: Any
+ ) -> List[Tensor]:
```
## Setup
Python 3.6 (or higher) and [pip](https://pip.pypa.io/en/stable/)/[conda](https://docs.conda.io/en/latest/miniconda.html) are required to install `ghapi`.
### Stable release
You can install the last stable release of the package using [pypi](https://pypi.org/project/ghapi-client/) as follows:
```shell
pip install ghapi-client
```
or using [conda](https://anaconda.org/frgfm/ghapi-client):
```shell
conda install -c frgfm ghapi-client
```
### Developer installation
Alternatively, if you wish to use the latest features of the project that haven't made their way to a release yet, you can install the package from source:
```shell
git clone https://github.com/frgfm/ghapi.git
pip install -e ghapi/.
```
## What else
### Documentation
The full package documentation is available [here](https://frgfm.github.io/ghapi/) for detailed specifications.
## Contributing
Feeling like extending the range of supported API feature? Or perhaps submitting a new feature idea? Any sort of contribution is greatly appreciated!
You can find a short guide in [`CONTRIBUTING`](CONTRIBUTING.md) to help grow this project!
## License
Distributed under the Apache 2.0 License. See [`LICENSE`](LICENSE) for more information.