Skip to main content

A TUI based awesome curated list finder

Project description


[![PyPI version](https://badge.fury.io/py/awesome-finder.svg)](https://badge.fury.io/py/awesome-finder) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/mingrammer/awesome-finder/blob/master/LICENSE)

# Awesome finder

> Find the awesome things without browser.
>
> What does mean awesome? The awesome seires provide a curated list of awesome frameworks, libraries, software and resources for a specific topic. An example is [awesome-python](https://github.com/vinta/awesome-python)

A TUI based finder for searching the awesome resources on awesome series such as `awesome-python`, `awesome-go` and so on.

With it, you can browse the awesome libraries, resources on your terminal without browser.

[![asciicast](https://asciinema.org/a/OOdH9rLVBvReK3K6n7pZvruf9.png)](https://asciinema.org/a/OOdH9rLVBvReK3K6n7pZvruf9)

<br>

## Installation

It supports **Python 3+** only now.

```bash
pip install awesome-finder # or pip3 install awesome-finder
```

<br>

## Usage

```bash
# Find awesome things from awesome-<topic>
awesome-hub <topic>

# Find awesome things from latest awesome-<topic> (not use cache)
awesome-hub <topic> -f (--force)

# Show help messages (can see supported awesome topics)
awesome-hub -h (--help)
```

There are some helper keys:

| Key | Description |
| ----------------- | ---------------------------------------- |
| Key up (**↑**) | Move and scroll up |
| Key down (**↓**) | Move and scroll down |
| Enter (↵) | Open the selected awesome link on default browser |
| Esc | Close the awesome finder |

<br>

## Supported awesome topics

> *Updates: 2017-09-10*

These will be updated continuously

- awesome
- awesome-android
- awesome-elixir
- awesome-go
- awesome-ios
- awesome-java
- awesome-javascript
- awesome-php
- awesome-python
- awesome-ruby
- awesome-rust
- awesome-scala
- awesome-swift

<br>

## Contributing

Details on [CONTRIBUTING](CONTRIBUTING.md)

<br>

## Changelog

Details on [CHANGELOG](CHANGELOG.md)

<br>

## TODO

* [ ] Query highlighting
* [ ] Supports paging with Key left (←) and Key right (→)
* [ ] Smart parsing with hierachical structure
* [ ] Supports all awesome series
* [ ] Supports initial query (example: `awesome python -q 'django oauth'`)
* [ ] Add options to open the Issue and Pull Request page of a specific awesome series


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

awesome-finder-1.1.1.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

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

awesome_finder-1.1.1-py2.py3-none-any.whl (18.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file awesome-finder-1.1.1.tar.gz.

File metadata

File hashes

Hashes for awesome-finder-1.1.1.tar.gz
Algorithm Hash digest
SHA256 0dcd0acbeb0bae58ad5d41889d28fc22335d6cfe6f5891672c5660a21a0aa04a
MD5 fbc1cca4ada45391d7efc183eb710fd9
BLAKE2b-256 98d46f433e06c45ef55433033eac13941f4f4f1682c53fce9c83ab26b0ee9a9c

See more details on using hashes here.

File details

Details for the file awesome_finder-1.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for awesome_finder-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 44eb6e8a659aa799303d345291698ae3ffd59ccc8cba1d3231757f0e7d92f72d
MD5 fc516bef2621f8ca04caeedca4e52ff4
BLAKE2b-256 f10c2c7a45358989c3cc01d2ae0592cd31b23cdb555aba88d921a7acec9a0ef2

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