Metadata-Version: 2.1
Name: pypandora
Version: 1.1.1
Summary: Python CLI and module for pandora
Home-page: https://github.com/pandora-analysis/pypandora
License: BSD-3-Clause
Author: Raphaël Vinot
Author-email: raphael.vinot@circl.lu
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
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
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet
Classifier: Topic :: Security
Provides-Extra: docs
Requires-Dist: Sphinx (>=5.1.1,<6.0.0); extra == "docs"
Requires-Dist: requests (>=2.28.1,<3.0.0)
Project-URL: Documentation, https://pypandora.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/pandora-analysis/pypandora
Description-Content-Type: text/markdown

# Python client and module for Pandora

## Installation

```bash
pip install pypandora
```

## Usage

### Command line

You can use the `pandora` command to submit a file:

```bash
$ pandora -h
usage: pandora [-h] [--url URL] (--redis_up | -f FILE)

Submit a file.

optional arguments:
  -h, --help            show this help message and exit
  --url URL             URL of the instance (defaults to https://pandora.circl.lu/).
  --redis_up            Check if redis is up.
  -f FILE, --file FILE  Path to the file to submit.

```

### Library

See [API Reference](https://pypandora.readthedocs.io/en/latest/api_reference.html)

