Metadata-Version: 2.3
Name: probely
Version: 0.0.1a2
Summary: CLI and SDK wrappers 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_cli.git
Project-URL: Bug Tracker, https://github.com/probely/probely_cli/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,sdk,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: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.8
Requires-Dist: environs
Requires-Dist: marshmallow
Requires-Dist: mergedeep
Requires-Dist: python-dateutil
Requires-Dist: pyyaml
Requires-Dist: requests
Requires-Dist: rich
Requires-Dist: rich-argparse
Requires-Dist: toml
Provides-Extra: docs
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-argparse-cli; extra == 'docs'
Requires-Dist: sphinx-markdown-builder; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: tox; extra == 'test'
Description-Content-Type: text/markdown

# probely

### Package level api key setup:

* Config File:
  Create `~/.probely/config` and add:

  ```
  [AUTH]
  api_key = <your_api_key>
  ```

* Environment Variables
  ```
  export PROBELY_API_KEY=<your_api_key>
  ```
* Tool specific config (see below)

## CLI

### Usage

* Use `-h/--help` for available options
* General usage:
    * `probely <context> <action> [positional_params ...] [--optinal params ...] -- [positional_params ...]`
    * `--` allows you to add positional args after optional
* add `--api-key` for command specific api key

## SDK

* Init `Probely` for specific config
  ```
  from probely_cli import Probely

  Probely.init(api_key=<your_api_key>)
  
  ...
  ```
* Import `probely_cli` for public interface

  ```
  import probely_cli

  target = probely_cli.add_target("https://target_url.com")
  ```

### Development guidelines:

* Command structure: `Probely <context> <action> params [--optinal params]`
* Follow CLI output good practices. Valid output to `stdout`, errors to `stderr`
* Custom tooling, developers should be aware
    * `rich.console` is always available on the `args`
    * `probely_cli`  pytest fixture (to call CLI commands)
* Error message should have the following structure: `{cmd}: error: {message}`,
  following the default implementation of argparse
    * eg: `probely targets get: error: filters and target ids are mutually exclusive.`

