Skip to main content

Bing Website Finder (bwf) adds websites to a list of company names from the commandline.

Project description

Bing Website Finder

## Purpose:
`bing_website_finder` (aka `bwf`) finds websites for an arbitrarily long list of company names.


## Requirements:
- Python >= 3.7
- A Bing Search API subscription
- A CSV full of company names


## Installation:

#### Direct download:
From the commandline run:
$ git clone
$ cd bing-website-finder/
$ pip install .

#### Without installing (python API):
$ git clone
$ cd bing-website-finder/
$ python --version `#check your python version to make sure it's >=3.7`
Python 3.7.2
$ python `#start python`
Python 3.7.2 (default, Jan 2 2119, 17:17:17) [MSC v.1111 2222 bit (DAM46)] :: Anaconda, Inc. on win3333
Type "help", "copyright", "credits" or "license" for more information.
And then:
>>> from bing_website_finder.get_websites import init
>>> from os import path
>>> infile = path.realpath('./bing_website_finder/data/example_input_website_finder.csv')
>>> outfile = path.realpath('./results.csv')
>>> bing_api_key = '987654321deadbeef123456789'
>>> init(infile, outfile, verbose=False, api_key=bing_api_key)


#### From pypi (NOT IMPLEMENTED YET):
$ pip install bing-website-finder

## Configuration & Usage:

#### Create a CSV input file:
Your input CSV **must** include the following 2 columns (case sensitive):
- Company Name
- Website

Check out `bing_website_finder/data/example_input_website_finder.csv` (which was gathered from [a very old SEC website]( for a practical example.

#### Permenantly store a Bing Search API Key in ``:
Locate the `bing_website_finder/` file & modify this line:

#### Python usage:
You can find the primary interface inside of `bing_website_finder/`.
It's called `init()`. Here is it's declaration as of v0.0.1:
def init(infilepth, outfilepth, verbose=False, api_key=None, num_workers=5):
assert os.path.exists(infilepth), "Please check the infile path you've specified."
cache = pd.read_csv(infilepth)
workers = (Worker(cache, api_key) for i in range(num_workers))
loop = asyncio.get_event_loop()
loop.run_until_complete(_execute(workers, verbose, loop=loop))
cache.to_csv(outfilepth, index=False)
If you do not specify an `api_key` argument, the `DEFAULT_SEARCH_API_V7_KEY` variable in `bing_website_finder/` will be used.


#### cmdline usage:
Insallation via pip automatically creates an executable and places it in your $PYTHONPATH.

If `/YOUR/PYTHON/ENV/bin`* is in your `$PATH`**, simply type:
$ bwf --help
$ bing_website_finder --help
if neither of these^ work after installation, you can always use:

$ python -m bwf --help
$ python -m bing_website_finder --help
\* - (`/YOUR/PYTHON/ENV/Scripts` on Windows)
\** - (`%PATH%` on Windows)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bwf, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size bwf-0.0.1-py3-none-any.whl (32.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size bwf-0.0.1.tar.gz (30.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page