Welcome to PyDragonfly’s documentation!

Robust Python SDK and Command Line Client for interacting with Certego’s Dragonfly service’s API.

Installation

$ pip install pydragonfly

Usage as CLI

On successful installation, The pydragonfly entryscript should be directly invokable. For example,

 $ pydragonfly
 Usage: pydragonfly [OPTIONS] COMMAND [ARGS]...

 Options:
   -d, --debug  Set log level to DEBUG
   --version    Show the version and exit.
   -h, --help   Show this message and exit.

 Commands:
   access-info  Get user access info
   analysis     Analysis Management
   config       Set or view config variables
   profile      Profile Management
   rule         Rule Management

Configuration:

You can use set to set the config variables and get to view them.

View on asciinema

$ pydragonfly config set -k <dragonfly_api_key>
$ pydragonfly config get

Hint

The CLI would is well-documented which will help you navigate various commands easily. Invoke pydragonfly -h or pydragonfly <command> -h to get help.

Usage as SDK/library

from pydragonfly import Dragonfly, DragonflyException

df = Dragonfly(api_key="<dragonfly_api_key>")

try:
   response = df.Analysis.list()
   print(response)
except DragonflyException as exc:
   print("Oh no! Error: ", exc)

Tip

We very much recommend going through the pydragonfly.Dragonfly docs.

Index

Usage

• Dragonfly client
  • Dragonfly class
• Resources
  • Action class
  • Analysis class
  • Invitation class
  • Organization class
  • Profile class
  • Report class
  • Rule class
  • Sample class
  • Session class
  • UserAccessInfo class
  • UserPreferences class
• Types
  • APIResponse class
  • TParams class
• Exceptions
  • DragonflyException class

Development

• Tests
  • Configuration
  • Launch Tests

Indices and tables

• Index

• Module Index