ferrisfind/README.md

ferrisfind

Find publicly available files given a company name, download them, and extract the metadata out of them.

Usage:

ferrisfind [OPTIONS] --name <NAME> --key <KEY>
-n, --name <NAME>
        company name

-k, --key <KEY>
        serpapi key

-p, --pages <PAGES>
        number of pages of results to get (note each page is a credit on your sperapi key, defaults to 10)

-t, --threads <THREADS>
        the number of threads to use, will default to the rayon default

-d, --download-path <DOWNLOAD_PATH>
        folder to download found files into defaults to ./found_files

-c, --csv <CSV>
        save metadata as csv

-m, --markdown <MARKDOWN>
        save metadata as csv

-h, --help
        Print help (see a summary with '-h')

-V, --version
        Print version

Examples:

Find PDFs for google and print metadata to console without saving it to a file:

ferrisfind -k {serpapi key} -n google

find PDFs for google and save to a csv file:

ferrisfind -k {serpapi key} -n google -c ./metadata.csv

find PDFs for google and save to a markdwon file:

ferrisfind -k {serpapi key} -n google -m ./metadata.md

find PDFs for google and save to both a CSV and Markdown file:

ferrisfind -k {serpapi key} -n google -c ./metadata.csv -m ./metadata.md

intall

clone this repo:

git clone https://git.pyro.monster/pyro/ferrisfind.git

cd into the repo and run the install script:

cd ferrisfind

./install.sh