GitHub API Package

A Python package used to interact with the GitHub RESTful API.

Installation

This package can be installed using the GitHub repository URL.

PIP

pip install git+https://github.com/ONS-Innovation/code-github-api-package.git

Poetry

poetry add git+https://github.com/ONS-Innovation/code-github-api-package.git

Usage

This package can be imported as a normal Python package.

Import whole module:

import github_api_toolkit

Import part of the module:

from github_api_toolkit import github_interface

Development

This project uses pip for package management. Poetry was avoided to keep the package size small.

To develop/test the project locally, clone the repository then navigate to its root directory and run the following:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

This will create a virtual environment, activate it and install all the project dependancies into it.

To deactivate the virtual environment, use:

deactivate

Commands

Please view the MkDocs documentation for more information about the toolkit's classes and functions.

Testing

This package uses pytest. To run the tests for the project, use:

pytest

All tests should pass.

Documentation

This project uses MkDocs for documentation which gets deployed to GitHub Pages at a repository level.

For more information about MkDocs, see the below documentation.

Getting Started with MkDocs

There is a guide to getting started on this repository's GitHub Pages site.