A Python cli for collecting and showing your github contributions as simple and detailed as possible.
Project description
that_is_me_on_github
that_is_me_on_github is a Python CLI application used for collect user's github contribution and generate markdown.
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.mdhustclf/that_is_me_on_github generate --username hustclf --org_filter apache --repo_filter hustclf/RateLimiter,ing-bank/flink-deployer,edenhill/kafkacat > markdown.md
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for that_is_me_on_github-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 999d73a662d08fec964232b299f906f9bd89f7e516222eece9cc8b697ef2f23b |
|
MD5 | c25edf7b8442edc026e723b866bc11d8 |
|
BLAKE2b-256 | 1061cec12940560aed977109357b105fcaa805b942fb0e3710a8d6231254f903 |