a CLI tool to search your GitHub stars.
Project description
# oh-my-stars
Search your stars locally.
```
usage: mystars [-h] [-l LANGUAGE [LANGUAGE ...]] [-u] [-r] [-a] [-3] [-i]
[-v]
[keywords [keywords ...]]
a CLI tool to search your starred Github repositories.
positional arguments:
keywords Search by keywords
optional arguments:
-h, --help show this help message and exit
-l LANGUAGE [LANGUAGE ...], --language LANGUAGE [LANGUAGE ...]
Filter by language
-u, --update Create(first time) or update the local stars index
-r, --reindex Re-create the local stars index
-a, --alfred Format search result as Alfred XML
-3, --three Format search result as Alfred 3 JSON
-i, --install Import Alfred workflow
-v, --version show program's version number and exit
```
![oh-my-stars](https://raw.github.com/wolfg1969/my-stars-pilot/master/oh-my-stars.png)
##### Works with Alfred Workflow
![oh-my-stars-alfred-workflow](https://raw.github.com/wolfg1969/my-stars-pilot/master/oh-my-stars-alfred-workflow.png)
### Configuration
You can avoid entering your GitHub API credentials every time you update the index, by adding them to the ``~/.netrc`` file as follows:
```ini
machine api.github.com
login ‹GH_USERNAME›
password ‹GH_API_TOKEN›
```
Use an API token as the password – you can create one via *Settings » Developer settings » Personal access tokens* in the GitHub web interface.
Once you have stored credentials, you can also automate the index update by adding a job with ``crontab -e``:
```sh
# GitHub stars
0 6 * * * ~/.local/bin/mystars -u
```
### Installation (Mac OSX)
```sh
$ pip install oh-my-stars --upgrade --user
$ mystars --help
$ mystars --update
$ mystars angular upload
$ mystars --language python
$ mystars awesome python
```
if install failed, try following commands
```sh
$ pip uninstall distribute
$ pip install setuptools
$ pip install --upgrade setuptools
```
### Integration with Alfred
```sh
$ mystars --install
```
### Change logs
##### v1.4.8
- Fix Alfred XML output
- Rewrite Alfred workflow script
##### v1.4.5
- Drop Python 2.6 Support
- Update docs: using ~/.netrc + cron. @jhermann
##### v1.3.5
- Output Alfred 3 JSON ouput with "-a -3" option.
- Import Alfred Workflow with "-i" (append "-3" for Alfred 3) option.
##### v1.2.3
- Get user + password from netrc. @jhermann.
- Use pipenv to manage project requirements.
##### v1.1.3
- Upgrade to TinyDB 3.7.0.
- Build index when updating.
- Search result pagination.
*Note*
- Uninstall existing version.
- Rebuild existing index with `mystars -r`.
##### v1.0.2
- Rename to oh-my-stars.
##### v1.0.1
- Support Github two-factor authentication. @yanyaoer
##### v1.0.0
- Replace kc with [TinyDB](https://github.com/msiemens/tinydb), no more non-python dependencies.
- Only update stars since last time.
Search your stars locally.
```
usage: mystars [-h] [-l LANGUAGE [LANGUAGE ...]] [-u] [-r] [-a] [-3] [-i]
[-v]
[keywords [keywords ...]]
a CLI tool to search your starred Github repositories.
positional arguments:
keywords Search by keywords
optional arguments:
-h, --help show this help message and exit
-l LANGUAGE [LANGUAGE ...], --language LANGUAGE [LANGUAGE ...]
Filter by language
-u, --update Create(first time) or update the local stars index
-r, --reindex Re-create the local stars index
-a, --alfred Format search result as Alfred XML
-3, --three Format search result as Alfred 3 JSON
-i, --install Import Alfred workflow
-v, --version show program's version number and exit
```
![oh-my-stars](https://raw.github.com/wolfg1969/my-stars-pilot/master/oh-my-stars.png)
##### Works with Alfred Workflow
![oh-my-stars-alfred-workflow](https://raw.github.com/wolfg1969/my-stars-pilot/master/oh-my-stars-alfred-workflow.png)
### Configuration
You can avoid entering your GitHub API credentials every time you update the index, by adding them to the ``~/.netrc`` file as follows:
```ini
machine api.github.com
login ‹GH_USERNAME›
password ‹GH_API_TOKEN›
```
Use an API token as the password – you can create one via *Settings » Developer settings » Personal access tokens* in the GitHub web interface.
Once you have stored credentials, you can also automate the index update by adding a job with ``crontab -e``:
```sh
# GitHub stars
0 6 * * * ~/.local/bin/mystars -u
```
### Installation (Mac OSX)
```sh
$ pip install oh-my-stars --upgrade --user
$ mystars --help
$ mystars --update
$ mystars angular upload
$ mystars --language python
$ mystars awesome python
```
if install failed, try following commands
```sh
$ pip uninstall distribute
$ pip install setuptools
$ pip install --upgrade setuptools
```
### Integration with Alfred
```sh
$ mystars --install
```
### Change logs
##### v1.4.8
- Fix Alfred XML output
- Rewrite Alfred workflow script
##### v1.4.5
- Drop Python 2.6 Support
- Update docs: using ~/.netrc + cron. @jhermann
##### v1.3.5
- Output Alfred 3 JSON ouput with "-a -3" option.
- Import Alfred Workflow with "-i" (append "-3" for Alfred 3) option.
##### v1.2.3
- Get user + password from netrc. @jhermann.
- Use pipenv to manage project requirements.
##### v1.1.3
- Upgrade to TinyDB 3.7.0.
- Build index when updating.
- Search result pagination.
*Note*
- Uninstall existing version.
- Rebuild existing index with `mystars -r`.
##### v1.0.2
- Rename to oh-my-stars.
##### v1.0.1
- Support Github two-factor authentication. @yanyaoer
##### v1.0.0
- Replace kc with [TinyDB](https://github.com/msiemens/tinydb), no more non-python dependencies.
- Only update stars since last time.
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
oh-my-stars-1.4.8.tar.gz
(19.5 kB
view hashes)
Built Distribution
Close
Hashes for oh_my_stars-1.4.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c046c95e74dbecdaa914c2cd6d6e56743f66012c9d057cb9eb6ad89175157664 |
|
MD5 | a82e05c8fe10bf20b7a64dfe28b24c16 |
|
BLAKE2b-256 | 5ae34df13d026a759b9b40369bf577726b627edccf013fa1cde0a9fd9084140e |