https://github.com/hustclf/that_is_me_on_github
A Python cli for collecting and showing your github contributions as simple and detailed as possible.
https://github.com/hustclf/that_is_me_on_github
cli click github-api github-contributions python
Last synced: about 1 month ago
JSON representation
A Python cli for collecting and showing your github contributions as simple and detailed as possible.
- Host: GitHub
- URL: https://github.com/hustclf/that_is_me_on_github
- Owner: hustclf
- License: mit
- Created: 2019-06-04T09:27:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-21T05:25:31.000Z (almost 4 years ago)
- Last Synced: 2024-08-11T11:06:13.203Z (over 1 year ago)
- Topics: cli, click, github-api, github-contributions, python
- Language: Python
- Homepage: https://pypi.org/project/that-is-me-on-github/
- Size: 87.9 KB
- Stars: 18
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# that_is_me_on_github
[](https://www.python.org/downloads/release/python-360/)
[](https://circleci.com/gh/hustclf/that_is_me_on_github)
[](https://microbadger.com/images/hustclf/that_is_me_on_github "Get your own image badge on microbadger.com")
[](https://microbadger.com/images/hustclf/that_is_me_on_github "Get your own version badge on microbadger.com")
[](https://opensource.org/licenses/MIT)
[](https://github.com/ellerbrock/open-source-badges/)
that_is_me_on_github is a Python CLI application used for collect user's github contribution and generate markdown.
[demo](https://github.com/hustclf/that_is_me_on_github/blob/master/demo.md)
## 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.**
```bash
$ 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:
```bash
$ 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 --auth_password
```
Replace and with your own.
## Development
that_is_me_on_github use pipenv for local development.
### 1.(Optional) Install pipenv
```bash
$ pip install pipenv
```
### 2. Build a pipenv environment
```bash
$ cd path-to-the-project/
$ pipenv shell
```
### 3. Under development.
Pycharm is the recommended ide.
### 4. Run tests.
```bash
$ pytest tests/
```