.. .. image:: https://readthedocs.org/projects/findref/badge/?version=latest
:target: https://findref.readthedocs.io/en/latest/
:alt: Documentation Status
.. .. image:: https://github.com/MacHu-GWU/findref-project/workflows/CI/badge.svg
:target: https://github.com/MacHu-GWU/findref-project/actions?query=workflow:CI
.. .. image:: https://codecov.io/gh/MacHu-GWU/findref-project/branch/main/graph/badge.svg
:target: https://codecov.io/gh/MacHu-GWU/findref-project
.. image:: https://img.shields.io/pypi/v/findref.svg
:target: https://pypi.python.org/pypi/findref
.. image:: https://img.shields.io/pypi/l/findref.svg
:target: https://pypi.python.org/pypi/findref
.. image:: https://img.shields.io/pypi/pyversions/findref.svg
:target: https://pypi.python.org/pypi/findref
.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
:target: https://github.com/MacHu-GWU/findref-project/blob/main/release-history.rst
.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
:target: https://github.com/MacHu-GWU/findref-project
------
.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg
:target: https://findref.readthedocs.io/en/latest/
.. .. image:: https://img.shields.io/badge/Link-API-blue.svg
:target: https://findref.readthedocs.io/en/latest/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Install-blue.svg
:target: `install`_
.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
:target: https://github.com/MacHu-GWU/findref-project
.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
:target: https://github.com/MacHu-GWU/findref-project/issues
.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
:target: https://github.com/MacHu-GWU/findref-project/issues
.. image:: https://img.shields.io/badge/Link-Download-blue.svg
:target: https://pypi.org/pypi/findref#files
Welcome to ``findref`` Documentation
==============================================================================
``findref`` is an interactive terminal app that can search tech documentation reference. It is Python, cross-platform, easy-to-install, and blazing fast.
.. image:: https://github.com/MacHu-GWU/findref-project/assets/6800411/e7bc899d-cf8b-46ea-84e3-2437e5a65014
:align: center
Usage Example
------------------------------------------------------------------------------
::
# install (you need Python3.8+)
$ pip install findref
# enter the interactive terminal app
$ fr
Then you can follow the hint and enter your query to search, it support fuzzy search, ngram search (See đ `supported-dataset`_)
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, if ``tf aws s3 bucket`` doesn't give you result, you can use ``tf aws s3 bucket!~`` to search again on the latest data.
**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 down.
- âŦ: hit ``Ctrl + F`` to scroll item selection down.
- âŦ
ī¸: 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.
- đ´: hit ``Ctrl + C`` to quit the app.
Request for New Dataset
------------------------------------------------------------------------------
You can `create a new issue <https://github.com/MacHu-GWU/findref-project/issues/new?assignees=MacHu-GWU&labels=feature&projects=&template=request_for_new_dataset.md&title=%5BNew+Dataset%5D+%3Cthe+name+of+the+dataset%3E>`_ and add the ``new dataset`` label to request for a new dataset. Please leave your comments, show me the link to the dataset you want to add, and provide some sample query and matched url items and ``@MacHu-GWU`` (me).
Request for Enterprise Support
------------------------------------------------------------------------------
findref works for enterprise internal dataset too. If you want a customized version to support your enterprise internal dataset, please follow the instruction in `this ticket <https://github.com/MacHu-GWU/findref-project/issues/new?assignees=MacHu-GWU&labels=enterprise+support&projects=&template=request_for_enterprise_support.md&title=%5BEnterprise+support%5D+%3Cname+of+your+company%3E>`_, our team will contact you soon.
.. _supported-dataset:
Supported Dataset
------------------------------------------------------------------------------
.. contents::
:class: this-will-duplicate-information-and-it-is-still-useful-here
:depth: 1
:local:
đ Airflow Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: https://asciinema.org/a/616811.svg
:target: https://asciinema.org/a/616811
đ AWS CloudFormation Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
todo
đ AWS boto3 Python SDK Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: https://asciinema.org/a/616817.svg
:target: https://asciinema.org/a/616817
đ AWS CDK Python Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: https://asciinema.org/a/616818.svg
:target: https://asciinema.org/a/616818
đ AWS CDK TypeScript Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: https://asciinema.org/a/616819.svg
:target: https://asciinema.org/a/616819
đ PySpark Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: https://asciinema.org/a/616821.svg
:target: https://asciinema.org/a/616821
đ Pandas Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
todo
đ Terraform Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Support AWS, Azure, GCP.
.. image:: https://asciinema.org/a/616822.svg
:target: https://asciinema.org/a/616822
.. _install:
Install
------------------------------------------------------------------------------
``findref`` is released on PyPI, so all you need is to:
.. code-block:: console
# you need Python3.8+
$ pip install findref
To upgrade to latest version:
.. code-block:: console
$ pip install --upgrade findref
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/findref-project",
"name": "findref",
"maintainer": "Sanhe Hu",
"docs_url": null,
"requires_python": "",
"maintainer_email": "husanhe@gmail.com",
"keywords": "",
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f8/2b/50164288a401669555f8cabacd3a3fee176afe036323b0d53ecc02e7e059/findref-0.2.2.tar.gz",
"platform": "Windows",
"description": "\n.. .. image:: https://readthedocs.org/projects/findref/badge/?version=latest\n :target: https://findref.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. .. image:: https://github.com/MacHu-GWU/findref-project/workflows/CI/badge.svg\n :target: https://github.com/MacHu-GWU/findref-project/actions?query=workflow:CI\n\n.. .. image:: https://codecov.io/gh/MacHu-GWU/findref-project/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/findref-project\n\n.. image:: https://img.shields.io/pypi/v/findref.svg\n :target: https://pypi.python.org/pypi/findref\n\n.. image:: https://img.shields.io/pypi/l/findref.svg\n :target: https://pypi.python.org/pypi/findref\n\n.. image:: https://img.shields.io/pypi/pyversions/findref.svg\n :target: https://pypi.python.org/pypi/findref\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/findref-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/findref-project\n\n------\n\n.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg\n :target: https://findref.readthedocs.io/en/latest/\n\n.. .. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://findref.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/findref-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/findref-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/findref-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/findref#files\n\n\nWelcome to ``findref`` Documentation\n==============================================================================\n``findref`` is an interactive terminal app that can search tech documentation reference. It is Python, cross-platform, easy-to-install, and blazing fast.\n\n.. image:: https://github.com/MacHu-GWU/findref-project/assets/6800411/e7bc899d-cf8b-46ea-84e3-2437e5a65014\n :align: center\n\n\nUsage Example\n------------------------------------------------------------------------------\n::\n\n # install (you need Python3.8+)\n $ pip install findref\n\n # enter the interactive terminal app\n $ fr\n\nThen you can follow the hint and enter your query to search, it support fuzzy search, ngram search (See \ud83d\ude80 `supported-dataset`_)\n\nIt will ask you to wait for building the search index for the first time. After that, it will be very fast to search.\n\nThe dataset will be updated automatically every 30 days. You can also use ``!~`` followed by any query to force update the dataset. For example, if ``tf aws s3 bucket`` doesn't give you result, you can use ``tf aws s3 bucket!~`` to search again on the latest data.\n\n**Keyboard shortcuts**:\n\n- \u2b06\ufe0f: hit ``Ctrl + E`` or ``UP`` to move item selection up.\n- \u23eb: hit ``Ctrl + R`` to scroll item selection up.\n- \u2b07\ufe0f: hit ``Ctrl + D`` or ``DOWN`` to move item selection down.\n- \u23ec: hit ``Ctrl + F`` to scroll item selection down.\n- \u2b05\ufe0f: hit ``Ctrl + H`` or ``LEFT`` to move query input cursor to the left (this won't work on Windows).\n- \u27a1\ufe0f: hit ``Ctrl + L`` or ``RIGHT`` to move query input cursor to the right.\n- \u23ea: hit ``Ctrl + G`` to move query input cursor to the previous word.\n- \u23e9: hit ``Ctrl + K`` to move query input cursor to the next word.\n- \u21a9\ufe0f: hit ``Ctrl + X`` to clear the query input.\n- \u25c0\ufe0f: hit ``BACKSPACE`` to delete query input backward.\n- \u25b6\ufe0f: hit ``DELETE`` to delete query input forward.\n- \ud83c\udf10: hit ``Enter`` to **open the reference in web browser**.\n- \u2705: hit ``Ctrl + A`` to copy the url to clipboard.\n- \ud83d\udd34: hit ``Ctrl + C`` to quit the app.\n\n\nRequest for New Dataset\n------------------------------------------------------------------------------\nYou can `create a new issue <https://github.com/MacHu-GWU/findref-project/issues/new?assignees=MacHu-GWU&labels=feature&projects=&template=request_for_new_dataset.md&title=%5BNew+Dataset%5D+%3Cthe+name+of+the+dataset%3E>`_ and add the ``new dataset`` label to request for a new dataset. Please leave your comments, show me the link to the dataset you want to add, and provide some sample query and matched url items and ``@MacHu-GWU`` (me).\n\n\nRequest for Enterprise Support\n------------------------------------------------------------------------------\nfindref works for enterprise internal dataset too. If you want a customized version to support your enterprise internal dataset, please follow the instruction in `this ticket <https://github.com/MacHu-GWU/findref-project/issues/new?assignees=MacHu-GWU&labels=enterprise+support&projects=&template=request_for_enterprise_support.md&title=%5BEnterprise+support%5D+%3Cname+of+your+company%3E>`_, our team will contact you soon.\n\n\n.. _supported-dataset:\n\nSupported Dataset\n------------------------------------------------------------------------------\n.. contents::\n :class: this-will-duplicate-information-and-it-is-still-useful-here\n :depth: 1\n :local:\n\n\n\ud83d\ude80 Airflow Reference\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n.. image:: https://asciinema.org/a/616811.svg\n :target: https://asciinema.org/a/616811\n\n\n\ud83d\ude80 AWS CloudFormation Reference\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\ntodo\n\n\n\ud83d\ude80 AWS boto3 Python SDK Reference\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n.. image:: https://asciinema.org/a/616817.svg\n :target: https://asciinema.org/a/616817\n\n\n\ud83d\ude80 AWS CDK Python Reference\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n.. image:: https://asciinema.org/a/616818.svg\n :target: https://asciinema.org/a/616818\n\n\n\ud83d\ude80 AWS CDK TypeScript Reference\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n.. image:: https://asciinema.org/a/616819.svg\n :target: https://asciinema.org/a/616819\n\n\n\ud83d\ude80 PySpark Reference\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n.. image:: https://asciinema.org/a/616821.svg\n :target: https://asciinema.org/a/616821\n\n\n\ud83d\ude80 Pandas Reference\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\ntodo\n\n\n\ud83d\ude80 Terraform Reference\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nSupport AWS, Azure, GCP.\n\n.. image:: https://asciinema.org/a/616822.svg\n :target: https://asciinema.org/a/616822\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``findref`` is released on PyPI, so all you need is to:\n\n.. code-block:: console\n\n # you need Python3.8+\n $ pip install findref\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade findref\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Find technical reference document in terminal.",
"version": "0.2.2",
"project_urls": {
"Download": "https://pypi.python.org/pypi/findref/0.2.2#downloads",
"Homepage": "https://github.com/MacHu-GWU/findref-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e95487e7ff4a45831a35cc7c39c4facb415183730cecc918c24ec8a13e48933a",
"md5": "f229fc728adcc6b57e9e204563078012",
"sha256": "8a97f00825a17c97b259bd8aac41c621017530deb31d2cfc2619b28f7a20292d"
},
"downloads": -1,
"filename": "findref-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f229fc728adcc6b57e9e204563078012",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23676,
"upload_time": "2024-02-15T20:01:43",
"upload_time_iso_8601": "2024-02-15T20:01:43.521254Z",
"url": "https://files.pythonhosted.org/packages/e9/54/87e7ff4a45831a35cc7c39c4facb415183730cecc918c24ec8a13e48933a/findref-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f82b50164288a401669555f8cabacd3a3fee176afe036323b0d53ecc02e7e059",
"md5": "3c20c00e661bce6ff4ab909d7d907a4c",
"sha256": "b4203a92d2dac670779dbb858154d5f1dda50756b67d5f2e2abaf3e01dfc56e3"
},
"downloads": -1,
"filename": "findref-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "3c20c00e661bce6ff4ab909d7d907a4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28369,
"upload_time": "2024-02-15T20:01:44",
"upload_time_iso_8601": "2024-02-15T20:01:44.838759Z",
"url": "https://files.pythonhosted.org/packages/f8/2b/50164288a401669555f8cabacd3a3fee176afe036323b0d53ecc02e7e059/findref-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-15 20:01:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "findref-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "findref"
}
JSON
