https://github.com/ufocoder/py-githubart

Github Contributions table Writer. Just for fun
https://github.com/ufocoder/py-githubart

Last synced: about 1 year ago
JSON representation

Github Contributions table Writer. Just for fun

• Host: GitHub
• URL: https://github.com/ufocoder/py-githubart
• Owner: ufocoder
• License: mit
• Created: 2015-04-21T21:13:25.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-05-07T17:05:21.000Z (about 11 years ago)
• Last Synced: 2025-04-19T02:23:10.431Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 363 KB
• Stars: 10
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Github Art

==========

[![Build Status](https://travis-ci.org/ufocoder/py-GithubArt.svg)](https://travis-ci.org/ufocoder/py-GithubArt)

[![PyPI Downloads](https://img.shields.io/pypi/dm/github_art.svg)](https://pypi.python.org/pypi?name=github_art)

[![Coverage Status](https://coveralls.io/repos/ufocoder/py-GithubArt/badge.svg?branch=master)](https://coveralls.io/r/ufocoder/py-GithubArt?branch=master)

Python project to write string on Contributions Github account table

Usage

-----

1. Clone project and move to project folder:

```

git clone https://github.com/ufocoder/py-GithubArt.git

cd py-GithubArt

```

2. Create folder to build git project, for example:

```

mkdir ~/build

```

3. Create github project

4. Run python github_art, there's an example of script usage:

```

python github_art \

    --string abc123 \

    --path ~/build \

    --username network-batman \

    --project gotham-city

```

Result Contributions table:

![Github Contributions](docs/abc123x1.png)

You could use other dictionary to write:

```

python github_art \

    --string abcef012345 \

    --dictionary alphanumeric2x \

    --path ~/build \

    --username network-batman \

    --project gotham-city

```

Result Contributions table:

![Github Contributions](docs/abcef012345x2.png)

There's [example](https://github.com/network-batman) of second github_art usage

Options

-------

* string - your string [required parameter]

* dictionary - alphanumeric or alphanumeric2x

* path - there's a path to your github project [required parameter]

* project - URL to your github project [required parameter]