Metadata-Version: 2.1
Name: fafi
Version: 0.2.2
Summary: CLI for indexing Firefox bookmarks.
License: MIT
Author: Sander van Dragt
Author-email: sander@vandragt.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: appdirs (>=1.4,<2.0)
Requires-Dist: click (>=8.0,<9.0)
Requires-Dist: newspaper3k (>=0.2,<0.3)
Description-Content-Type: text/x-rst


Fafi
====

Search Firefox bookmark contents, with this commandline client. Fafi extracts the content of the bookmarks and stores them into a searchable SQLite database.

Things it does:


* Detects your places database from the Firefox profile folder. (support for picking a profile from multiple profiles)
* Extract main text content from all bookmarks into ``<user_data_dir>/fafi/data.sqlite``.
* Skips .local and .test domains.
* Skips pages that are already indexed.
* Search results are ranked by relevance and displayed with snippets.

URLs are stored together with the main page context as determined by `Newspaper <https://github.com/codelucas/newspaper>`_.

Users
-----

.. code-block::

   pipx install fafi
   fafi --help
   fafi index
   fafi search 'linux'

Developers
----------

.. code-block::

   # Install project requirements.
   poetry install

   # Log in to a python shell
   poetry shell

   # Help on commands
   ./fafi.py --help
   
   # Index bookmarks
   ./fafi.py index

   # Search for linux
   ./fafi.py search 'linux'


.. image:: https://user-images.githubusercontent.com/594871/76201330-ffcba880-61ea-11ea-9fdd-cc32a90deecd.png
   :target: https://user-images.githubusercontent.com/594871/76201330-ffcba880-61ea-11ea-9fdd-cc32a90deecd.png
   :alt: search query


