Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,13 +206,18 @@ Ensure you have **Python 3.12 or later** installed before proceeding with the in

```bash
python3 --version
```
```

Subdominator core modules doesn't include PDF generation dependency, if you fancy a PDF report, use PDF extra tags when installing:
```bash
pipx install 'subdominator[PDF]'
```

#### ✅ **Install Subdominator from PyPI** (Recommended)
The easiest way to install Subdominator is via PyPI:

```bash
pip install --upgrade subdominator
pip install --upgrade 'subdominator[PDF]'
```

#### ✅ **Install the Latest Version from GitHub**
Expand All @@ -226,13 +231,13 @@ pip install --upgrade git+https://github.com/RevoltSecurities/Subdominator
To avoid dependency conflicts, you can install Subdominator using `pipx`:

```bash
pipx install subdominator
pipx install 'subdominator[PDF]'
```

To install the latest version from GitHub with `pipx`:

```bash
pipx install git+https://github.com/RevoltSecurities/Subdominator
pipx install 'subdominator[PDF] @ git+https://github.com/RevoltSecurities/Subdominator'
```

#### ✅ **Install from Git Source** (For Development)
Expand All @@ -242,7 +247,7 @@ For users who want to contribute or modify the tool, clone and install directly
git clone https://github.com/RevoltSecurities/Subdominator.git
cd Subdominator
pip install --upgrade pip
pip install -r requirements.txt
pip install -e . # or pip install -e ".[PDF]" to support PDF report generation
```

After installation, you can verify if Subdominator is installed correctly by running:
Expand Down
29 changes: 16 additions & 13 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,19 @@ aiofiles>=24.1.0
aiohttp>=3.10.11
appdirs>=1.4.4
art>=6.4
beautifulsoup4>=4.13.3
colorama>=0.4.6
fake_useragent>=2.0.3
httpx>=0.28.1
Jinja2>=3.1.6
prompt_toolkit>=3.0.50
PyYAML>=6.0.2
Requests>=2.32.3
rich>=13.9.4
setuptools>=75.6.0
SQLAlchemy>=2.0.32
tldextract>=5.1.2
weasyprint>=65.0
beautifulsoup4>=4.13.3
colorama>=0.4.6
fake_useragent>=2.0.3
httpx>=0.28.1
Jinja2>=3.1.6
prompt_toolkit>=3.0.50
PyYAML>=6.0.2
Requests>=2.32.3
rich>=13.9.4
setuptools>=75.6.0
SQLAlchemy>=2.0.32
tldextract>=5.1.2
aiosqlite>=0.21.0
greenlet>=3
socksio>=1

8 changes: 7 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,15 @@
'setuptools>=75.6.0',
'SQLAlchemy>=2.0.32',
'tldextract>=5.1.2',
'weasyprint>=65.0',
'aiosqlite>=0.21.0',
'socksio>=1',
'greenlet>=3',
],
extra_require={
"PDF": [
'weasyprint>=65.0',
],
},
entry_points={
'console_scripts': [
'subdominator = subdominator.subdominator:main'
Expand Down
Loading