Skip to main content

washer

Create fulltext indexes with your files and query them from the command line.

Install

With pip or (better) pipsi <https://github.com/mitsuhiko/pipsi>:

pipsi install --python (which python3) washer
# or `sudo pip3 install washer`

Quickstart

https://raw.githubusercontent.com/fiatjaf/washer/master/example/screenshot.png

Or see https://github.com/fiatjaf/washer/tree/master/example.

Usage

Usage: washer [OPTIONS] COMMAND [ARGS]...

Options:
  -d, --indexdir DIRECTORY  The directory in which the index files will be
                            kept. Defaults to a temporary directory.
  --help                    Show this message and exit.

Commands:
  index     Creates or overwrites and index at an...
  info      Display information about the index and...
  morelike  Lists files present at the index that share...
  search    Search the given index for a term or multiple...
Usage: washer index [OPTIONS] [FILES_TO_INDEX]...

  Creates or overwrites and index at an specified location using the given
  files.

  FILES_TO_INDEX accepts multiple files and wildcards, as usual.

Options:
  -l, --lang [ar|da|nl|en|fi|fr|de|hu|it|no|pt|ro|ru|es|sv|tr]
                                  Comma-separated list of languages to use
                                  when indexing. Should be specified multiple
                                  times. Defaults to "-l pt -l en".
  --help                          Show this message and exit.
Usage: washer search [OPTIONS] [QUERY]...

  Search the given index for a term or multiple terms.

  QUERY can be anything, typically it will be just one or a bunch of words,
  but it accepts special operators (NOT, AND, *, ? etc.) as specified in
  http://whoosh.readthedocs.io/en/latest/querylang.html

Options:
  --count             Force counting results. A mostly useless flag.
  --frag / --no-frag  Show text fragments of the files that matched.Enabled by
                      default.
  --help              Show this message and exit.

License

This tool is licensed in the same way as Whoosh, as long as it complies with requirements from the other two dependencies, click and blessings.

Metadata

Release files for washer 0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for washer 0.6
File Size Uploaded
washer-0.6.tar.gz 4.9 kB Details

Release files / washer-0.6.tar.gz

Download URL washer-0.6.tar.gz
Size 4.9 kB
Tags Source
SHA-256 checksum
How to use checksums
a65431f1c88647f0a75876e61bfeb53f6bc9de6f509c8e04ca802e19ea6d9b49
BLAKE2b-256 checksum
How to use checksums
70cd8abe13e7effca5c70bf8dce2e8ae76263f94a946a4ccedcc345efb6109da
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.6 This release

1 release file

0.5

1 release file

0.4

1 release file

0.3

1 release file

0.2

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page