Skip to main content

A Python cli for collecting and showing your github contributions as simple and detailed as possible.

Project description

that_is_me_on_github

PyPI Python 3.6 CircleCI License: MIT Open Source Love svg1

that_is_me_on_github is a Python CLI application used for collect user's github contribution and generate markdown.

demo

Quick Start

Option 1: run with pip

$ pip install that_is_me_on_github
$ that_is_me_on_github generate --username hustclf --org_filter apache --repo_filter hustclf/RateLimiter,ing-bank/flink-deployer,edenhill/kafkacat

A markdown file named that_is_me_on_github.md will be generated under current folder.

Option 2: run with Docker

Notice: docker will create a folder automatically when not exist. To aovid it, We should create an empty file manually.

$ docker pull hustclf/that_is_me_on_github
$ touch ~/result.md
$ docker run -it --rm -v ~/result.md:/usr/src/that_is_me_on_github/that_is_me_on_github.md hustclf/that_is_me_on_github generate --username hustclf --org_filter apache --repo_filter hustclf/RateLimiter,ing-bank/flink-deployer,edenhill/kafkacat

Notice: provided with github auth info:

--auth_username and --auth_password are optional parameters. Without auth info, it is easily to reach the rate limit of github api, you can provide your account to avoid it.

For example:

$ that_is_me_on_github generate --username hustclf --org_filter apache --repo_filter hustclf/RateLimiter,ing-bank/flink-deployer,edenhill/kafkacat \\ 
--do_auth True --auth_username <github_username> --auth_password <github password>

Replace <github_username> and <github_password> with your own.

Development

that_is_me_on_github use pipenv for local development.

1.(Optional) Install pipenv

$ pip install pipenv

2. Build a pipenv environment

$ cd path-to-the-project/
$ pipenv shell

3. Under development.

Pycharm is the recommended ide.

4. Run tests.

$ pytest tests/

Project details


Download files

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

Files for that-is-me-on-github, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size that_is_me_on_github-0.0.4.tar.gz (4.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page