Repository files navigation

Note: this only deals with metadata. If you want a download of actual git repositories, I recommend usingpython-github-backup.

1. The easiest way ispip3 install --user git+https://github.com/karlicoss/ghexport.

   Alternatively, usegit clone --recursive, orgit pull && git submodule update --init. After that, you can usepip3 install --editable.

2. To use the API, you need to get apersonal access token from settings. Note that you need to userepo scope.

Usage:

Recommended: createsecrets.py keeping your api parameters, e.g.:

token = "TOKEN"

After that, use:

python3 -m ghexport.export --secrets /path/to/secrets.py

That way you type less and have control over where you keep your plaintext secrets.

Alternatively, you can pass parameters directly, e.g.

python3 -m ghexport.export --token <token>

However, this is verbose and prone to leaking your keys/tokens/passwords in shell history.

You can also importghexport.export as a module and callget_json function directly to get raw JSON.

Ihighly recommend checking exported files at least once just to make sure they contain everything you expect from your export. If not, please feel free to ask or raise an issue!

• you can control specific data you want to export via--include option (see--help for available fields)

  By default, all data will be included in the export.

• you can include or excluderepository traffic data via--include-repos-traffic or--exclude-repos-traffic.

  Currently it’s included by default.

  You might want to exclude it if you have some issues with traffic API endpoint (it tends to be flakier than other endpoints).

WARNING: github API limits extent to which you can retrieve certain data, e.g.events you can only get events from the past 90 days, and not more than 300 events.

Ihighly recommend to export regularly and keep old exports. Easy way to achieve it is command like this:

python3 -m ghexport.export --secrets /path/to/secrets.py >"export-$(date -I).json"

Or, you can usearctee that automates this.

To get your older data past 90 days, you can request amanual export in your account settings.

Therequests (and thereforePyGithub) modules on which this depends seems to sometimes fail to login if a~/.netrc file is present, seehere for context.

You can useghexport.dal (stands for “Data Access/Abstraction Layer”) to access your exported data, even offline. I elaborate on motivation behind ithere.

• main usecase is to be imported as python module to allow forprogrammatic access to your data.

  You can find some inspiration in=my.= package that I’m using as an API to all my personal data.

• to test it against your export, simply run:python3 -m ghexport.dal --source /path/to/export
• you can also try it interactively:python3 -m ghexport.dal --source /path/to/export --interactive

Example output:

Your events:Counter({'PushEvent': 181,         'WatchEvent': 27,         'CreateEvent': 22,         'IssueCommentEvent': 20,         'PullRequestEvent': 15,         'IssuesEvent': 5,         'DeleteEvent': 5,         'ForkEvent': 3,         'PullRequestReviewCommentEvent': 1})