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

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for awesome-finder-1.0.3.tar.gz
Algorithm Hash digest
SHA256 8aff296d7d66c1ad82433abe96038603bc243a397594ee9acea783a59ba16f05
MD5 d40737b8f0eeb24366e66b5859118432
BLAKE2b-256 f7ff8c1eabc841fdca0b6e6159c557ee6c7e58c87747ea24c0e3c82977cb1df6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for awesome_finder-1.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4c367d18fe05558da62e6b02c2520d6e7ed56ae912c73875754ff8dfabacc0bd
MD5 dd70b8672b1e2c0a4e5380bbaa9e930e
BLAKE2b-256 3eb7dfb6d51ca75c317145c9bb69598d553dc46059d83ca95d8f671c1321f571

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