Skip to main content

Convert your GitHub issues into printable cards for your physical Scrum/Kanban board.

Project description

# GitHub Cards

[![PyPI](https://img.shields.io/pypi/v/github_cards.svg)](https://pypi.python.org/pypi/github_cards)
[![Travis](https://img.shields.io/travis/larsrinn/github_cards.svg)](https://travis-ci.org/larsrinn/github_cards)
[![Documentation Status](https://readthedocs.org/projects/github-cards/badge/?version=latest)](https://github-cards.readthedocs.io/en/latest/?badge=latest)

Convert your GitHub issues into printable cards for your physical Scrum board.

* Free software: MIT license
* Documentation: https://github-cards.readthedocs.io.


## Features

This tool creates a printable HTML-file containing the issues of a GitHub repository.
You can print the file, cut the cards and attach them to your physical Scrum/Kanban board.

To use it, run

```bash
# github_cards REPOSITORY_OWNER REPOSITORY_NAME
github_cards pallets click
```

There are some options available, e.g. to access private repositories or only select a certain milestone.

```bash
github_cards --help

# Usage: github_cards [OPTIONS] OWNER REPOSITORY
#
# Console script for github_cards.
#
# Options:
# -u, --username TEXT
# -m, --milestone-title TEXT
# -m#, --milestone-number TEXT
# -s, --state TEXT
# -o, --output TEXT
# --help Show this message and exit.

```

### ToDo
* [ ] Unspaghettify
* [ ] Add some tests
* [ ] Add documentation
* [ ] Caching of already covered cards

## Credits

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.


=======
History
=======

0.1.0 (2018-11-25)
------------------

* First release on PyPI.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github_cards-0.1.3.tar.gz (9.9 kB view hashes)

Uploaded Source

Built Distribution

github_cards-0.1.3-py2.py3-none-any.whl (5.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page