Skip to main content

WerkScout - search and email scraping helpers

Project description

WerkScout

WerkScout is a Python library designed to help you slice large search requests into manageable, polite chunks and extract relevant data (e.g., emails) from web pages.

Features

  • Simple search query slicing: allows segmentation by domain, keyword patterns, and more.
  • Email scraping with Selenium: robust routines using ScrapeScript.py.
  • Domain lookup helpers: utility functions in searchEngines.py.
  • SQLite support: integrated DbContext.py for storing and retrieving data.
  • API abstraction: central API handling in Api.py.
  • Respectful web scraping: rate limiting and retry logic built in—designed to avoid getting blocked.

Installation

WerkScout is still under development. To install locally for development:

git clone https://github.com/MahmoudYazid/WerkScout.git
cd WerkScout
python -m venv .venv
source .venv/bin/activate             # On Windows: .\.venv\Scripts\Activate.ps1
pip install -r requirements.txt
pip install -e .

Usage Example

from ScrapeScript import start_EmailsList_Scrape_From_Domain
from searchEngines import FindDomain_autocompleteclearbit

# Fetch a domain via search engine
domain = FindDomain_autocompleteclearbit("example query")

# Scrape emails from that domain
emails = start_EmailsList_Scrape_From_Domain(domain)

print(f"Found {len(emails)} emails:")
for e in emails:
    print(" –", e)

Contributing

Contributions are welcome! Please follow these guidelines:

  1. Fork the repo and create a feature branch for your changes.
  2. Submit a pull request with a clear description and tests where applicable.
  3. Note: You may not publish this library under a different name or claim ownership—see CONTRIBUTING.md and LICENSE for details.

License

This project is licensed under the MIT License. See the LICENSE file for details.


Contact & Learn More

Created by Mahmoud Yazid. For questions or issues, open an issue on GitHub or reach out via LinkedIn [profile].

Project details


Download files

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

Source Distribution

werkscout-0.1.0.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

werkscout-0.1.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file werkscout-0.1.0.tar.gz.

File metadata

  • Download URL: werkscout-0.1.0.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for werkscout-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2252d44e85d3f9dc28e15c8df5eb41e66e47342757c975fd6a0902d7627634a3
MD5 998ad9c7f738caf9fb5c69292fc5c091
BLAKE2b-256 6b9aed2c7bce0b90f261d03c6c978b41e27039245f215a8aafe95c139dd1eaf2

See more details on using hashes here.

Provenance

The following attestation bundles were made for werkscout-0.1.0.tar.gz:

Publisher: workflows.yml on MahmoudYazid/WerkScout

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file werkscout-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: werkscout-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for werkscout-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 49dbf69740ab635197db9d97153cb826e61f7d8a6a446a500cb295dd86cf08a1
MD5 bd17f0fc44f6c27d5018ec968a122021
BLAKE2b-256 1ceb1e0ac3bb1f7d4125f6ebc70a28a514452b5dd94a28a87a11112245e5edff

See more details on using hashes here.

Provenance

The following attestation bundles were made for werkscout-0.1.0-py3-none-any.whl:

Publisher: workflows.yml on MahmoudYazid/WerkScout

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page