Metadata-Version: 2.0
Name: github-vanity
Version: 0.1.1
Summary: Write to your GitHub activity chart
Home-page: https://github.com/ihabunek/github-vanity/
Author: Ivan Habunek
Author-email: ivan.habunek@gmail.com
License: MIT
Keywords: github vanity activity chart write
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: GitPython (>=2.1.0)

======================
Vanity text for GitHub
======================

Write to your GitHub activity chart.

Licensed under the MIT License, see `LICENSE <LICENSE>`_.

Installation
------------

Install from the cheese shop.

.. code-block:: bash

    pip install github-vanity

Usage
-----

Initialize an empty Git repository which you will submit to GitHub.

Populate the repo with the desired text:

.. code-block:: bash

    vanity write "Hello there!"

Push the repo to GitHub and presto!

.. image:: https://raw.githubusercontent.com/ihabunek/github-vanity/master/vanity.jpg

Reference
---------

``vanity write [options] text``

- **text** - text to write to the commit chart

Available options:

- **-h**, **--help** - show usage instructions
- **-d**, **--start_date** - the date to start with, **should be a Sunday**
- **-o**, **--offset** - number of spaces to leave to the left (default is 0)
- **-s**, **--spacing** - spacing between letters (default is 1)
- **-w**, **--space_width** - width of space character (default is 4)
- **-c**, **--commits** - number of commits per pixel (default is 50)

The default ``start_date`` is the Sunday 52 weeks before the last one, which
is the first pixel visible on the commit chart.


