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.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/
Metadata
Release files for that-is-me-on-github 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| that_is_me_on_github-0.0.4.tar.gz | 4.9 kB | Without provenance | Details for that_is_me_on_github-0.0.4.tar.gz |
Release files / that_is_me_on_github-0.0.4.tar.gz
| Download URL | that_is_me_on_github-0.0.4.tar.gz |
|---|---|
| Size | 4.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b5b4af8ae282703f795605fe36b6fbb56233a4edbcae1573d49539240d9a9cb7
|
|
BLAKE2b-256 checksum How to use checksums |
f0810e1c22d2f20a35b6d04d280f1adc2c8ea909b18dfadb2955b478dd735b36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.5
|
Security for that-is-me-on-github 0.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.