Skip to main content

a command line tool for downloading repositories and gists

Project description

Build Status codecov

github-dl is a lightweight command line tool for downloading repositories from `github.com <http://github.com>`__ and gists from `gist.github.com <http://gist.github.com>`__. github-dl has been tested on python 2.7.12 and python 3.5.2.

Installation

The project was recently added to PYPI. Feel free to submit an issue if there are any issues with downloading via the command below…

pip install github-dl

Installation (Development)

Install the project by downloading the project as a zip file or cloning the repository. After downloading the source, run the following command to install in the root directory of the project…

pip install -e .

Usage

github-dl’s functionality is currently fairly limited, but the following functionality is supported

usage for both commands

command line argument/option functionality
--help list arguments/options for tool
--username github username for credentials
--password github password for credentials
--token github token for credentials
--config directory to a configuration file

usage specific for $ github-dl

command line argument/option functionality
queries query for filtering github repositories
destination directory to download repositories to

examples:

Download all machine learning related notebooks matching a criteria: - $ github-dl 'machine learning language:jupyter-notebook size:<1000' github-notebooks --config=config.json

usage specific for $ gist-dl

command line argument/option functionality
sources list of github users accounts to download gists
destination directory to download gists to
--extension file extension to download ex: ipynb

examples:

Download all public jupyter notebooks: - $ gist-dl gist-notebooks --config=config.json --extension=ipynb

Download a specific user’s public jupyter notebooks: - $ gist-dl cameres gist-notebooks --config=config.json --extension=ipynb

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
github_dl-0.1a9-py2.py3-none-any.whl (6.2 kB) Copy SHA256 hash SHA256 Wheel py2.py3
github-dl-0.1a9.tar.gz (4.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page