| Name | github-contrib-view JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | View your GitHub contributions as a graph in the terminal. |
| upload_time | 2025-07-19 14:46:53 |
| maintainer | None |
| docs_url | None |
| author | Grant Ramsay |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# GitHub Contributions Viewer
A Python package to view your GitHub yearly contributions in the terminal,
duplicating the 'grass' map from your GitHub profile pages.
Right now this app has minimal functionality and configuration, it will become
much more useful very quickly!
## Installation
You can install the package as a standalone tool using
[`uv`](https://docs.astral.sh/uv/):
```console
uv tool install github-contrib-view
```
or `pipx`:
```console
pipx install github-contrib-view
```
Or simply use `pip` to install to your current virtualenv or global python:
```console
pip install github-contrib-view
```
If you prefer to install it manually, you can clone the repository and run the
following command:
```console
uv sync
source .venv/bin/activate # or .venv/Scripts/activate on Windows
```
In the above case, you will need to have `uv` installed.
## Setup
You will need to have a GitHub Personal Access Token to use this, get one from
[GitHub](https://github.com/settings/tokens).
Once you have one, you will need to set 2 env variables:
```ini
USERNAME=seapagan # YOUR GitHub username
GITHUB_PAT=ghp_xxxxxxxxxxxxxxxxxxxxxxxxx # the PAT you generated.
```
Instead of this, you can specify either or both from the command line. These
will take preference over any environment variables:
```console
ghcview --username seapagan --token ghp_xxxxxxxxxxxxxxxxxxxxxxxxx
```
You can use either or both.
## Usage
Run the viewer as:
```console
ghcview
```
Currently there are 3 CLI options in addition to the `--username` and `--token`
mentioned above:
- `--ascii` / `--no-ascii` : Use ASCII characters instead of the default emojis
for the coloured boxes. Default is `--no-ascii`.
- `--summary` / `--no-summary` : Display a summary of the past year's
contribuitions under the chart. Default is `--summary`.
- `--help` : Display brief help for the program.
Raw data
{
"_id": null,
"home_page": null,
"name": "github-contrib-view",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Grant Ramsay",
"author_email": "Grant Ramsay <seapagan@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3f/b3/36627ceba8b58b865b725f299d6c745e16236433feff57a132f4b790716f/github_contrib_view-0.2.0.tar.gz",
"platform": null,
"description": "# GitHub Contributions Viewer\n\nA Python package to view your GitHub yearly contributions in the terminal,\nduplicating the 'grass' map from your GitHub profile pages.\n\nRight now this app has minimal functionality and configuration, it will become\nmuch more useful very quickly!\n\n## Installation\n\nYou can install the package as a standalone tool using\n[`uv`](https://docs.astral.sh/uv/):\n\n```console\nuv tool install github-contrib-view\n```\n\nor `pipx`:\n\n```console\npipx install github-contrib-view\n```\n\nOr simply use `pip` to install to your current virtualenv or global python:\n\n```console\npip install github-contrib-view\n```\n\nIf you prefer to install it manually, you can clone the repository and run the\nfollowing command:\n\n```console\nuv sync\nsource .venv/bin/activate # or .venv/Scripts/activate on Windows\n```\n\nIn the above case, you will need to have `uv` installed.\n\n## Setup\n\nYou will need to have a GitHub Personal Access Token to use this, get one from\n[GitHub](https://github.com/settings/tokens).\n\nOnce you have one, you will need to set 2 env variables:\n\n```ini\nUSERNAME=seapagan # YOUR GitHub username\nGITHUB_PAT=ghp_xxxxxxxxxxxxxxxxxxxxxxxxx # the PAT you generated.\n```\n\nInstead of this, you can specify either or both from the command line. These\nwill take preference over any environment variables:\n\n```console\nghcview --username seapagan --token ghp_xxxxxxxxxxxxxxxxxxxxxxxxx\n```\n\nYou can use either or both.\n\n## Usage\n\nRun the viewer as:\n\n```console\nghcview\n```\n\nCurrently there are 3 CLI options in addition to the `--username` and `--token`\nmentioned above:\n\n- `--ascii` / `--no-ascii` : Use ASCII characters instead of the default emojis\n for the coloured boxes. Default is `--no-ascii`.\n- `--summary` / `--no-summary` : Display a summary of the past year's\n contribuitions under the chart. Default is `--summary`.\n- `--help` : Display brief help for the program.\n",
"bugtrack_url": null,
"license": null,
"summary": "View your GitHub contributions as a graph in the terminal.",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c4b366dfda81fc588ec0cb083af9e06246c2664bc840aa269a662d5d4e33c5fa",
"md5": "4911bd318481aba0bfc5deac19c5e563",
"sha256": "1cf228dec83e6154702d9dbcb7ab34dcefcb05e2e5b77f714f0c9a717015edd9"
},
"downloads": -1,
"filename": "github_contrib_view-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4911bd318481aba0bfc5deac19c5e563",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6133,
"upload_time": "2025-07-19T14:46:52",
"upload_time_iso_8601": "2025-07-19T14:46:52.076862Z",
"url": "https://files.pythonhosted.org/packages/c4/b3/66dfda81fc588ec0cb083af9e06246c2664bc840aa269a662d5d4e33c5fa/github_contrib_view-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3fb336627ceba8b58b865b725f299d6c745e16236433feff57a132f4b790716f",
"md5": "6da12f9363751222ef79d43a9219f85d",
"sha256": "d10cb370213b37d98d2e2c3c105f5b41cf6d107bbd8a0854ebca871eb2cdba27"
},
"downloads": -1,
"filename": "github_contrib_view-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6da12f9363751222ef79d43a9219f85d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5809,
"upload_time": "2025-07-19T14:46:53",
"upload_time_iso_8601": "2025-07-19T14:46:53.333468Z",
"url": "https://files.pythonhosted.org/packages/3f/b3/36627ceba8b58b865b725f299d6c745e16236433feff57a132f4b790716f/github_contrib_view-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-19 14:46:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "github-contrib-view"
}
