• Stars
    star
    528
  • Rank 83,941 (Top 2 %)
  • Language
    Jupyter Notebook
  • License
    Apache License 2.0
  • Created almost 4 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A delightful and complete interface to GitHub's amazing API

ghapi

ghapi provides 100% always-updated coverage of the entire GitHub API. Because we automatically convert the OpenAPI spec to a Pythonic API, ghapi is always up to date with the latest changes to GitHub APIs. Furthermore, because this is all done dynamically, the entire package is only 35kB in size!

Using ghapi, you can automate nearly anything that you can do through the GitHub web interface or through the git client, such as:

There are two ways to use ghapi: either through Python, or from the command line. An overview of each is provided below.

Installation

To install, run either pip install ghapi or conda install -c fastai ghapi.

How to use - Python

Throughout this documentation, you will see code inputs and outputs shown in this format:

1+1
2

We recommend reading the documentation on the official site, rather than on GitHub, since not all the functionality described on this page is available through the GitHub viewer.

All of the documentation is available directly as Jupyter Notebooks, for instance the current page you’re reading is available as a notebook here. To open any page as an interactive notebook in Google Colab, click the Colab badge at the top of the page.

To access the GitHub API, first create a GhApi object:

from ghapi.all import GhApi
api = GhApi()

Every part of the API includes documentation directly in the api object itself. For instance, here’s how to explore the groups of functionality provided by the API by displaying the object:

api

Then we can explore the endpoints provided by the API in each group, e.g. for the git group:

api.git

Here’s how to learn about an endpoint you want to use, e.g.:

api.git.get_ref

git.get_ref(owner, repo, ref): Get a reference

In Jupyter Notebook full tab completion, parameter lists, etc are provided for all endpoints. Endpoints are called as standard Python methods:

api.git.get_ref(owner='fastai', repo='fastcore', ref='heads/master')

To use ghapi to access authenticated operations (other than when running through GitHub Actions), you will need a GitHub personal access token, which is a secret code used to access your account. If you don’t have one, click here to create one. You’ll be asked to enter a name – choose anything you like, for instance “ghapi”. You’ll also be asked to choose “scopes”; this limits what you’ll be able to do with the API using this token. If you’re not sure, click “repo” “gist”, “notifications”, and “workflow”. Then click “Generate Token” at the bottom of the screen, and copy the token (the long string of letters and numbers shown). You can easily do that by clicking the little clipboard icon next to the token.

Rather than pasting that token into every script, it’s easiest to save it as an environment variable. If you save it as $GITHUB_TOKEN then it will be most convenient, so add this to the end of your .bashrc or .zshrc file:

export GITHUB_TOKEN=xxx

…replacing the xxx with the token you just copied. (Don’t forget to source that file after you change it.), pass a [GitHub token].

As well as your token, you can also pass any parameters you want auto-inserted into relevant methods, such as owner and repo:

api = GhApi(owner='fastai', repo='fastcore', token=github_token)

We can now repeat the previous method, but only need to pass ref:

api.git.get_ref('heads/master')

Now that we’ve provided our token, we can use authenticated endpoints such as creating an issue:

issue = api.issues.create("Remember to check out GhApi!")

Since we’ve now checked out GhApi, let’s close this issue. 😎

api.issues.update(issue.number, state='closed')

How to use - command line

You can use GhApi via the command line, and can access nearly everything in the GitHub API. We provide an overview here of one of the command line programs, ghapi – see the full CLI docs page for details on all the programs available.

We strongly recommend enabling tab completion for ghapi, which you can do by placing the following command at the end of your ~/.bashrc or ~/.zshrc file:

eval "$(completion-ghapi --install)"

To get started with the ghapi command, first find the name of the operation you wish to perform, for instance by searching the full API reference.

To use ghapi, pass the method name (exactly the same as you’d use in the Python API) as the first parameter, followed by any positional parameters required, and then keyword arguments with “--” before each parameter name.

For instance, git.get_ref takes three parameters: owner, repo, and ref. If we wish to pass the first two as positional parameters, and the last as a named argument, then we’d call:

ghapi git.get_ref fastai ghapi-test --ref heads/master

If you have enabled tab completion, then after you’ve typed ghapi g try pressing Tab, and you’ll see all the operation groups available in the GitHub API that start with g. If you keep typing, e.g. ghapi git., and hit Tab again, you’ll now see all the operations available in the git group, i.e:

git.create_blob git.create_commit git.create_ref git.create_tag git.create_tree git.delete_ref git.get_blob git.get_commit git.get_ref git.get_tag git.get_tree git.list_matching_refs git.name git.update_ref git.verbs

If you pass just --help after the operation name, you’ll see a full list of all parameters accepted, and a link to the official GitHub documentation.

ghapi git.get_ref --help
>>> git.get_ref(owner, repo, ref)
>>> https://docs.github.com/rest/reference/git#get-a-reference

In addition to --help and the GitHub operation parameters, you can also pass the following:

  • --headers: A list of extra headers to pass, JSON-encoded
  • --token: A GitHub authentation token
  • --debug: Print requests before sending them

More Repositories

1

fastai

The fastai deep learning library
Jupyter Notebook
26,176
star
2

fastbook

The fastai book, published as Jupyter Notebooks
Jupyter Notebook
21,305
star
3

numerical-linear-algebra

Free online textbook of Jupyter notebooks for fast.ai Computational Linear Algebra course
Jupyter Notebook
10,134
star
4

courses

fast.ai Courses
Jupyter Notebook
5,571
star
5

course-v3

The 3rd edition of course.fast.ai
Jupyter Notebook
4,906
star
6

nbdev

Create delightful software with Jupyter Notebooks
Jupyter Notebook
4,829
star
7

fastpages

An easy to use blogging platform, with enhanced support for Jupyter Notebooks.
Jupyter Notebook
3,522
star
8

course-nlp

A Code-First Introduction to NLP course
Jupyter Notebook
3,414
star
9

course22

The fast.ai course notebooks
Jupyter Notebook
2,318
star
10

lm-hackers

Hackers' Guide to Language Models
Jupyter Notebook
1,756
star
11

fastprogress

Simple and flexible progress bar for Jupyter Notebook and console
Jupyter Notebook
1,083
star
12

fastcore

Python supercharged for the fastai library
Jupyter Notebook
961
star
13

imagenette

A smaller subset of 10 easily classified classes from Imagenet, and a little more French
Jupyter Notebook
934
star
14

course20

Deep Learning for Coders, 2020, the website
Jupyter Notebook
845
star
15

fastai2

Temporary home for fastai v2 while it's being developed
Jupyter Notebook
645
star
16

fastai_dev

fast.ai early development experiments
Jupyter Notebook
639
star
17

diffusion-nbs

Getting started with diffusion
Jupyter Notebook
606
star
18

course22p2

course.fast.ai 2022 part 2
Jupyter Notebook
471
star
19

swiftai

Swift for TensorFlow's high-level API, modeled after fastai
Jupyter Notebook
457
star
20

course-v4

Please use fastbook's /clean folder instead of this
446
star
21

imagenet-fast

Python
302
star
22

nbdev_template

Template for nbdev projects
Python
290
star
23

timmdocs

Documentation for Ross Wightman's timm image model library
Jupyter Notebook
277
star
24

numerical-linear-algebra-v2

Jupyter Notebooks for Computational Linear Algebra course, taught summer 2018 in USF MSDS program
Jupyter Notebook
269
star
25

fast_template

A template for really easy blogging with GitHub Pages
HTML
250
star
26

fastdoc

Create publication-quality books from Jupyter notebooks
Jupyter Notebook
230
star
27

fastsetup

Setup all the things
Shell
219
star
28

fastdiffusion

Notes and plans for fastdiffusion course
Jupyter Notebook
202
star
29

fastai_old

OLD REPO - PLEASE USE fastai/fastai
Jupyter Notebook
179
star
30

docker-containers

Docker images for fastai
Shell
172
star
31

book_nbs

Notebooks for upcoming fastai book (draft / incomplete)
Jupyter Notebook
166
star
32

fastscript

A fast way to turn your python function into a script
CSS
164
star
33

word-embeddings-workshop

This contains materials for the word embeddings workshop
HTML
123
star
34

fastec2

AWS EC2 computer management for regular folks
Python
121
star
35

execnb

Execute a jupyter notebook, fast, without needing jupyter
Jupyter Notebook
111
star
36

fastai1

v1 of the fastai library. v2 is the current version. v1 is still supported for bug fixes, but will not receive new features.
Jupyter Notebook
98
star
37

tf-fit

Fit your tensorflow model using fastai and PyTorch
Python
91
star
38

fastgpu

A queue service for quickly developing scripts that use all your GPUs efficiently
Jupyter Notebook
81
star
39

fastsql1

A bit of extra usability for sqlalchemy v2.
Jupyter Notebook
77
star
40

nbdev-template

Python
74
star
41

book.fast.ai

Information for readers of the fastai book
Jupyter Notebook
67
star
42

fastdot

A simple wrapper over `pydot` and `graphviz` which fixes some sharp edges
Jupyter Notebook
63
star
43

fastkaggle

Kaggling for fast kagglers!
Jupyter Notebook
52
star
44

nbprocess-old

Process and export Jupyter Notebooks fast (Jupyter not required)
Jupyter Notebook
52
star
45

randomized-SVD

demos for PyBay talk: Using Randomness to make code faster
Jupyter Notebook
50
star
46

fastai3

Research repo for code that may or may not end up in fastai3
Jupyter Notebook
50
star
47

pypi_template

A minimal template for creating a pypi package
Python
49
star
48

fastbook2e

The fastai book, 2nd edition (in progress)
Jupyter Notebook
46
star
49

fastdownload

Easily download, verify, and extract archives
Jupyter Notebook
44
star
50

course22-web

Website for Practical Deep Learning for Coders 2022
Jupyter Notebook
43
star
51

fastforest

A forest that is fast
C++
41
star
52

dotfiles

Vim Script
41
star
53

nbdev-vscode

TypeScript
41
star
54

bear_voila

Demo bear classifier with fastai and Voila
Jupyter Notebook
40
star
55

workflows

Composite Actions workflows for use in fastai projects
Python
39
star
56

tinykernel

A minimal Python kernel so you can run Python in your Python
Python
39
star
57

wireguard-fast

Simplified installation of WireGuard server for Ubuntu
Shell
37
star
58

minai

A miniture AI training framework for PyTorch
Jupyter Notebook
35
star
59

tinypets

Minimal JS interface to an image classifer
HTML
34
star
60

fastai-nbstripout

much faster nbstripout and autotrust notebooks local git configuration
Python
33
star
61

fastai-docs

Documentation for fastai
HTML
32
star
62

pagegraph

Draw, modify, and execute graphs using a simple python dict interface
Jupyter Notebook
29
star
63

masks4all

Make your own mask. My mask protects you. Your mask protects me.
Jupyter Notebook
26
star
64

apl-study

fast.ai APL study group notes
Jupyter Notebook
25
star
65

fastconda

Get packages onto your conda channel faster
Jupyter Notebook
22
star
66

git-tools

Tools to make git easier to use and to avoid the learning curve
Python
20
star
67

tweetrel

Use GitHub Actions to send a tweet when you make a new release
Jupyter Notebook
18
star
68

fastcgi

A fastcgi handler for Python's `socketserver` classes
Jupyter Notebook
17
star
69

fastrelease

DEPRECATED--all functionality moved to nbdev
Jupyter Notebook
15
star
70

fastpy

An easy way to start a python programming environment using GitHub Codespaces.
15
star
71

paperspace-setup

Setup a paperspace instance for fastai
Shell
14
star
72

ethics.fast.ai

The fast.ai data ethics course
Jupyter Notebook
14
star
73

fastcups

HTML
14
star
74

jupytercon-2023

Materials for "Write, Document, Test and Distribute Python Packages With Jupyter & Quarto", JupyterCon 2023.
Jupyter Notebook
14
star
75

fastlinkcheck

Check local static links and online links fast and in parallel
Jupyter Notebook
13
star
76

nbdev-index

nbdev docs lookup for a few libraries and python itself
Python
12
star
77

dlcert2

Web site source for Practical Deep Learning for Coders (2018)
Jupyter Notebook
12
star
78

Str8Pix

find the optimal rotation to correct skewed photos
Jupyter Notebook
11
star
79

dlcert1

Deep learning certificate part 1
10
star
80

cards_deck

A minimal example of nbdev based on Allen Downey's Think Python 2nd Ed
Jupyter Notebook
10
star
81

docments

Document parameters using comments
10
star
82

nbdev2

Temporary repo for nbdev2
Jupyter Notebook
7
star
83

spacy_conda

conda packages for spacy and deps
7
star
84

hugo-mathjax

Hugo with goldmark-mathjax
Jupyter Notebook
6
star
85

fastwebhook

A simple GitHub webhook server
Jupyter Notebook
6
star
86

wandbfastai

Jupyter Notebook
5
star
87

nbeverything

5
star
88

nbdev-jekyll-theme

CSS
4
star
89

nbdev_cards

A sample of how to create a deck of cards lib using nbdev
Jupyter Notebook
4
star
90

nbdev-demo

4
star
91

getcaddy

Simple approach to getting the Caddy web server
Shell
4
star
92

nbdev-spaces-demo

A demo of how to create a Hugging Face Space with gradio within a nbdev project.
Jupyter Notebook
4
star
93

fastdispatch

Wrapper for plum dispatch to make it more compatible with fastcore's typedispatch
Jupyter Notebook
3
star
94

tanishq_blog

CSS
3
star
95

docs

3
star
96

ghtop-demo

A CLI tool for showing GitHub events, written with Rich
Jupyter Notebook
3
star
97

logos

Logos for fastai for use in websites, icons, etc.
2
star
98

jb-nbdev

Exploring how nbdev may integrate with JupyterBook
Jupyter Notebook
2
star
99

nbdev-hello-world

Hello world from nbdev
Python
2
star
100

conda-recipes

Recipes for non-fastai projects that fastai provides packages for.
Python
2
star