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.2.tar.gz (8.5 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.2-py2.py3-none-any.whl (16.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for awesome-finder-1.0.2.tar.gz
Algorithm Hash digest
SHA256 4c97dd81baaca6854fb370e14d4d4a4271680393c8aca2cf33ccbec4c1c0c28e
MD5 ad30307e44e9c72125851db34e273566
BLAKE2b-256 5bc6c342c7dd5031cf6661bd31519b66bd8005ba8d5dbf31e5245eb756a2c070

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for awesome_finder-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a7e6dad30ad06e9aed9151e1f3f79ea5e86fd84a0fc009acadede953d748ca39
MD5 5d1c0578119e65e3e155fa518ddc1d44
BLAKE2b-256 40fff3eb46e21ebfe12a6a893ac272f2f0b5baef7898f1020d5990a038cdfdce

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