Metadata-Version: 2.5
Name: lupaxa-cms-detection
Version: 0.1.0
Summary: Detect which CMS a website is using from public signals.
Project-URL: Homepage, https://cms-detection.thelupaxaproject.org/
Project-URL: Documentation, https://cms-detection.thelupaxaproject.org/
Project-URL: Repository, https://github.com/lupaxa-security-toolbox/cms-detection
Project-URL: Issues, https://github.com/lupaxa-security-toolbox/cms-detection/issues
Author: The Lupaxa Project
License: MIT License
        
        Copyright (c) The Lupaxa Project
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENCE
Keywords: cli,cms,fingerprint,recon,security
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: beautifulsoup4>=4.12
Requires-Dist: requests>=2.32
Provides-Extra: dev
Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
Requires-Dist: hatch>=1.12.0; extra == 'dev'
Requires-Dist: mkdocs-material==9.7.7; extra == 'dev'
Requires-Dist: mkdocs==1.6.1; extra == 'dev'
Requires-Dist: mypy>=1.12.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.6.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest-cov>=5.0; extra == 'test'
Requires-Dist: pytest>=8.0; extra == 'test'
Description-Content-Type: text/markdown

<!-- markdownlint-disable -->
<p align="center">
  <a href="https://github.com/lupaxa-security-toolbox">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/security-toolbox/readme-logo.png" alt="Project Logo" width="256"/><br/>
  </a>
</p>
<h3 align="center">
  The Lupaxa Security Toolbox<br />
  Part of The Lupaxa Project
</h3>

<br />

# lupaxa-cms-detection

Identify which CMS a website is using from public signals — name, evidence,
version when it is exposed, and a confidence rating.

Built for authorised security-assessment recon used by The Lupaxa Project.

> [!WARNING]
> **Authorised use only.** Use this tool for authorised security-assessment
> recon only. You must have permission to test the target.

## Features

- Detect a CMS from public signals: generator tags, headers, cookies, and scripts
- Report **name**, **evidence**, **version** when it is exposed, and **confidence**
- Quiet default: homepage plus confirm files for CMS that already scored
- Optional **`--active`** broader path probes, including a catalogue confirm sweep when the homepage is quiet (a path is never a hit from HTTP 200 alone)
- Library API (`detect` / `detect_many`) and CLI (`cms-detection`)
- Text, JSON, and CSV output
- Fully typed, linted, formatted, and tested

## Installation

### From PyPI

```bash
pip install lupaxa-cms-detection
```

### From source (development mode)

```bash
pip install -e ".[dev]"
```

Requires Python 3.10+. Runtime dependencies: `requests`, `beautifulsoup4`.

## Library quick start

```python
from lupaxa.cms_detection import detect

result = detect("https://example.com", active=False)
print(result.cms, result.version, result.confidence)
```

## CLI quick start

```bash
cms-detection --help
cms-detection https://example.com
cms-detection https://example.com --active
cms-detection urls.txt --format json --output results.json
```

You can also run the CLI as a module:

```bash
python -m lupaxa.cms_detection --help
python -m lupaxa.cms_detection --version
```

## Documentation

Online documentation:

[Documentation](https://cms-detection.thelupaxaproject.org/)

Source repository:

[GitHub](https://github.com/lupaxa-security-toolbox/cms-detection)

### Serve docs locally

From a clone of the repository:

```bash
make mkdocs-serve
```

Then open the local URL printed by MkDocs in your browser.

## Development

Clone the repository and install with Make:

```bash
make init                # first-time makefile-skills checkout
make python-install-dev  # editable install with [dev]
make python-check        # lint, type-check, and test
```

<a href="https://github.com/the-lupaxa-project">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
</a>
