DESCRIPTION
Project description
Summary
thank-you-stars is a CLI tool to stars to a PyPI package and its dependencies.
thank-you-stars will do:
Find a repository on GitHub correlated with the PyPI package
Star the repository if found
Repeat 1. and 2. for each of the dependency packages
Usage
Prerequisite
Generate a personal access token at GitHub developer settings with public_repo scope
Install target PyPI packages
Basic usage
$ thank-you-stars <PyPI package>
Initial setup and add stars to GitHub repositories
With --setup option, you can configure an access token and star to repositories at the same time.
$ thank-you-stars thank-you-stars --setup
personal access token (required): <input personal access token>
Collect package info: 100%|████████████████████████| 2/2 [00:00<00:00, 196.82it/s]
Collect GitHub info: 100%|████████████████████████| 14/14 [00:00<00:00, 29.11it/s]
[INFO] tys: skip owned repository: thank-you-stars
[INFO] tys: skip owned repository: thombashi/DateTimeRange
[INFO] tys: star to PyGithub/PyGithub
[INFO] tys: star to tartley/colorama
[INFO] tys: star to getlogbook/logbook
[INFO] tys: skip owned repository: thombashi/mbstrdecoder
[INFO] tys: skip owned repository: thombashi/msgfy
[INFO] tys: skip owned repository: thombashi/pathvalidate
[INFO] tys: skip owned repository: thombashi/pytablewriter
[INFO] tys: star to requests/requests
[INFO] tys: star to pypa/setuptools
[INFO] tys: star to simplejson/simplejson
[INFO] tys: skip owned repository: thombashi/subprocrunner
[INFO] tys: star to tqdm/tqdm
--setup option not required for subsequent execution.
Add stars GitHub repositories from a package source
$ cd <path to a package source>
$ thank-you-stars .
[INFO] tys: star to xxxx
...
Check starred status
$ thank-you-stars thank-you-stars --check
Increase the repository traversal depth and output verbosity
$ thank-you-stars thank-you-stars --check -vv --depth 4
Command help
$ thank-you-stars -h
usage: thank-you-stars [-h] [--version] [--token TOKEN] [--config CONFIG]
[--setup] [--check] [-v] [--depth DEPTH]
[--include-owner-repo] [--no-cache] [--dry-run]
[--debug | --quiet] [--stacktrace]
target
Give stars a PyPI package and its dependencies.
positional arguments:
target PyPI package name or path to the package source code
directory
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
--dry-run Do no harm.
--debug for debug print.
--quiet suppress execution log messages.
Configurations:
--token TOKEN GitHub personal access token that has public_repo
scope.
--config CONFIG path to a conig file. the config file expected to
contain token: { "token" : <GitHub personal access
token that has public_repo scope> } (defaults to
~/.thank-you-stars.json).",
--setup setup token interactively, and then starring.
Star Status:
--check list starred status for each package with tabular
format and exit. does not actually star to found
GitHub repositories.
-v, --verbosity increase output verbosity.
Repository Search:
--depth DEPTH depth to recursively find dependencies of
dependencies." 0 means to star specified the package
only. 1 means to star specified the package and its
dependencies. equals to 2 or greater will increase the
depth of traverse that dependencies of dependencies.
--include-owner-repo starred to repositories that owned by you.
--no-cache disable the local caches.
Debug:
--stacktrace print stack trace for debug information. --debug
option required to see the debug print.
Issue tracker: https://github.com/thombashi/thank-you-stars/issues
Installation
pip install thank-you-stars
Dependencies
Python 2.7+ or 3.4+
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
thank-you-stars-0.0.1.tar.gz
(16.6 kB
view hashes)
Built Distribution
Close
Hashes for thank_you_stars-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a89122639a203e3f00abf2c4454fc98b532e1dbaf0392a2e687e36da72ad018f |
|
MD5 | 0bbda4c1b1a739abed2fa0b372352c6a |
|
BLAKE2b-256 | 4d0c20ea6a3fdad49d721db17217e40e91f7af7af7cffad116f09e1221229f22 |