5. Python API Reference

This package defines a Python interface for installing, managing, querying, and performing other operations on Zeek Packages and Package Sources. The main entry point is the Manager class.

This package provides a logger named LOG to which logging stream handlers may be added in order to help log/debug applications.

The following Python modules are all provided as part of the zeekpkg public interface:

• 5.1. zeekpkg.manager module
  • Manager
  • Stage
• 5.2. zeekpkg.package module
  • InstalledPackage
  • METADATA_FILENAME
  • Package
  • PackageInfo
  • PackageStatus
  • PackageVersion
  • aliases()
  • canonical_url()
  • dependencies()
  • is_valid_name()
  • make_builtin_package()
  • name_from_path()
  • short_description()
  • tags()
  • user_vars()
• 5.3. zeekpkg.source module
  • AGGREGATE_DATA_FILE
  • INDEX_FILENAME
  • Source
• 5.4. zeekpkg.template module
  • Error
  • Feature
  • GitError
  • InputError
  • LoadError
  • OutputError
  • Package
  • Template
• 5.5. zeekpkg.uservar module
  • UserVar
  • slugify()