Metadata-Version: 2.4
Name: probely
Version: 0.0.1a12
Summary: CLI wrapper for Probely's API
Project-URL: Homepage, https://probely.com
Project-URL: Documentation, https://developers.probely.com
Project-URL: Repository, https://github.com/probely/probely-python.git
Project-URL: Bug Tracker, https://github.com/probely/probely-python/issues
Author-email: Probely <hello@probely.com>
Maintainer-email: João Silva <joao.silva@probely.com>, Vladimir Kontic <vladimir@probely.com>, Temidire Adams <temidire@probely.com>
License: BSD 3-Clause License
        
        Copyright (c) 2024, Probe.ly Solucoes de Cibersegurança LDA
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Keywords: api,cli,client,probely,wrapper
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.8
Requires-Dist: environs
Requires-Dist: marshmallow
Requires-Dist: mergedeep
Requires-Dist: pydantic[email]
Requires-Dist: python-dateutil
Requires-Dist: pyyaml
Requires-Dist: requests
Requires-Dist: rich
Requires-Dist: rich-argparse
Requires-Dist: toml
Provides-Extra: dev
Requires-Dist: datamodel-code-generator; extra == 'dev'
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff==0.8.6; extra == 'dev'
Requires-Dist: tox; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-argparse-cli; extra == 'docs'
Requires-Dist: sphinx-markdown-builder; extra == 'docs'
Description-Content-Type: text/markdown


# Probely

## Installation

Probely CLI requires Python 3.8 or higher.  
Install the package using pip:  

```sh
pip install probely==0.0.1a11
```

This project is currently in its alpha stage and undergoing rapid development.  
As a result, significant changes that could impact existing implementations may occur without notice.  
To maintain stability, **we strongly recommend pinning the project version you are using.**

## Overview

Probely is a vulnerability scanner for APIs and web applications, designed to empower security teams and software developers in scanning and securing their web applications and APIs. 

This package provides a Command-Line Interface (CLI) to interact with the Probely API, allowing you to perform actions like scanning targets, listing findings, and managing targets directly from your terminal.

**For detailed documentation and usage examples, please visit our [CLI documentation](https://developers.probely.com/cli/overview-cli-documentation).**

## Contributing

We appreciate your interest in Probely! While we are not currently accepting external contributions, we welcome feedback and bug reports. If you encounter any issues or have suggestions, please create an issue on our GitHub repository.
