Metadata-Version: 2.4
Name: simple-subdomain-finder
Version: 0.2.0
Summary: A free subdomain enumeration library using DNS queries, Common Crawl data, and optional Digital Yama API
Author-email: DigitalYama <contact@digitalyama.com>
License: GPL-3.0
Project-URL: Homepage, https://github.com/Digital-Yama/simple-subdomain-finder
Project-URL: Repository, https://github.com/Digital-Yama/simple-subdomain-finder
Project-URL: Issues, https://github.com/Digital-Yama/simple-subdomain-finder/issues
Keywords: subdomain,enumeration,dns,security
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp
Requires-Dist: dnspython
Requires-Dist: validators
Requires-Dist: requests
Dynamic: license-file

# simple-subdomain-finder
Simple Subdomain Finder is a subdomain enumeration library written in Python. Use it to get a list of subdomains that exist for a specified domain.

Simple Subdomain Finder does not break any website terms of service and is suitable for running at scale. Simple Subdomain Finder uses DNS queries, Common Crawl data, and the Digital Yama API (optional) to find and enumerate subdomains.

## Usage

#### Installation
```bash
pip install simple-subdomain-finder
```

#### Basic
```python
from simple_subdomain_finder import get_subdomains

results = get_subdomains("basspro.com")
print(results.subdomains)
```

#### Full
```python
from simple_subdomain_finder import get_subdomains

results = get_subdomains("basspro.com", digitalyama_api_key="YOURAPIKEY")
print(results.subdomains)
```
## Not A Scraper
Because Subdomain Finder doesn't attempt to scrape data from websites (eg. Google), Subdomain Finder can be used to enumerate subdomains for large batches of domains. To avoid exceeding the rate limits enforced by Common Crawl, it's recommended that you do not use async or threading to speed up requests.

## Digital Yama API
You can optionally provide an API key from [digitalyama.com](https://digitalyama.com/) to expand results using the [Digital Yama Subdomain Finder API](https://digitalyama.com/api/subdomain-finder). Using the API will result in significantly more subdomains being found, including more hidden/non-obvious subdomains.

## Subdomains List
This package includes a list of subdomains to scan for DNS records. The included list is a modified version of the n0kovo_subdomains list. You can use a different list by modifying the file subdomains_list.txt.
