Skip to main content

A TUI based awesome finder

Project description


# Awesome finder

> Find the awesome things without browser

A TUI based finder for searching the awesome things 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 <topic>

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

# Show help messages (can see supported awesome topics)
awesome -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-elixir
- awesome-go
- awesome-java
- awesome-javascript
- awesome-php
- awesome-python
- awesome-ruby
- awesome-rust
- awesome-scala
- awesome-swift

<br>

## Contributing

Details on [CONTRIBUTING](CONTRIBUTING.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.0.4.tar.gz (8.4 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.0.4-py2.py3-none-any.whl (16.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for awesome-finder-1.0.4.tar.gz
Algorithm Hash digest
SHA256 5b68cd50815be49b70553ee2cdbce6d86d8494e7850bd0a0e33316f589204173
MD5 c71868f4f27523048c2d283b999e8eb6
BLAKE2b-256 a9d536495bfcc4f9675439fb8196f1475ee8a367072c37c0ea7b301f3b2376d7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for awesome_finder-1.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 09d30c697f0d2289e69b057411d19cceba41f1fcef8b19b98da7deebee48736f
MD5 edfcec020ab6e564e0e58aa32851ff91
BLAKE2b-256 8421901f7ea624fbadbb9790411775b09201377f19efe7b1dd8b6c383157119f

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