findref 0.0.6

Package short description.

---

Welcome to findref Documentation

Usage Example

# install
$ pip install findref

# enter the dataset name
$ tf # Terraform reference
$ cdk-python # AWS CDK Python reference
$ boto3 # AWS boto3 Python SDK reference

Then you can enter your query to search, it support fuzzy search, ngram search.

It will ask you to wait for building the search index for the first time. After that, it will be very fast to search.

The dataset will be updated automatically every 30 days. You can also use !~ followed by any query to force update the dataset. For example tf, then aws s3 bucket!~.

Keyboard shortcuts:

• hit Ctrl + E or UP to move item selection up.

• hit Ctrl + R to scroll item selection up.

• hit Ctrl + D or DOWN to move item selection up.

• hit Ctrl + F to scroll item selection up.

• hit Ctrl + H or LEFT to move query input cursor to the left (this won’t work on Windows).

• hit Ctrl + L or RIGHT to move query input cursor to the right.

• hit Ctrl + G to move query input cursor to the previous word.

• hit Ctrl + K to move query input cursor to the next word.

• hit Ctrl + X to clear the query input.

• hit BACKSPACE to delete query input backward.

• hit DELETE to delete query input forward.

• hit Enter to open the reference in web browser.

• hit Ctrl + A to copy the url to clipboard.

Request for New Dataset

You can create a new issue and add the new dataset label to request for a new dataset. Please leave your comments and show me the link to the dataset you want to add.

Supported Dataset

Terraform Reference

Support AWS, Azure, GCP.

AWS CDK Python Reference

AWS boto3 Python SDK Reference

Install

findref is released on PyPI, so all you need is to:

$ pip install findref

To upgrade to latest version:

$ pip install --upgrade findref