Skip to main content

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

Project description

GitHub Cards

PyPI Travis Documentation Status

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

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

# 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.

>> github_cards --help

Usage: github_cards [OPTIONS] OWNER REPOSITORY

  Console script for github_cards.

Options:
  -u, --username TEXT            Username to perform authenticated requests
                                 with. If provided, the script will request
                                 the password.
  -p, --password TEXT            Password for the username provided. If the
                                 username is set but the password is not
                                 provided, script will request it.
  -m, --milestone-title TEXT     Limit selected issues to a milestone by the
                                 milestone's title. It will search the
                                 repository for that milestone and error if
                                 it's not available.
  -m#, --milestone-number TEXT   Limit selected issue to a milestone by the
                                 milestone's number (similarly to issue
                                 numbers). Will be overwritten by the
                                 milestone title if set.
  -s, --state [all|open|closed]  Limit to all, open or closed issues. Defaults
                                 to open
  -pr, --per-row INTEGER         Number of cards per row
  -pc, --per-column INTEGER      Number of cards per column
  -o, --output PATH              HTML filename to output to. Defaults to a
                                 value containing the repository title and the
                                 current time.
  --help                         Show this message and exit.                     Show this message and exit.

ToDo

  • Unspaghettify
  • Error handling
  • Add some tests
  • Add documentation
  • Caching of already covered cards
  • User provided templates
  • Authentication
  • List milestones

Credits

This package was created with Cookiecutter and the 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.22.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

github_cards-0.1.22-py2.py3-none-any.whl (9.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file github_cards-0.1.22.tar.gz.

File metadata

  • Download URL: github_cards-0.1.22.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for github_cards-0.1.22.tar.gz
Algorithm Hash digest
SHA256 ccfbc5e27fce7bd9fcb8bd1797bf3f9d9465873fd13ec79a96ef98f7134b3a10
MD5 4c083b39be4e17fa7d773cd9db3017ec
BLAKE2b-256 b4a09fb2713eadbd1d6714a5879684cd3e46c253c56d1420c33b4d7d4ea5c461

See more details on using hashes here.

File details

Details for the file github_cards-0.1.22-py2.py3-none-any.whl.

File metadata

  • Download URL: github_cards-0.1.22-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for github_cards-0.1.22-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8cd695e3f0bf908c4bf945e69efc2ea965be2a81a6546a9da6ebf4826908bde4
MD5 dbbed988dae26a9e1d49be118cdc716f
BLAKE2b-256 e1dd066f90f2e576263b2c2a6c5ee7421157f5e5d1bebbb735816aeeff02ae92

See more details on using hashes here.

Supported by

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