Installation#

Install HFortix packages for Fortinet product automation.

Overview#

HFortix is a modular Python SDK for Fortinet products:

  • hfortix-core - Core HTTP client, exception framework, and formatting utilities

  • hfortix-fortios - FortiOS/FortiGate API client (1,348 endpoints)

  • hfortix-fortimanager - FortiManager API client (coming soon)

  • hfortix-fortianalyzer - FortiAnalyzer API client (coming soon)

Requirements#

  • Python 3.10 or higher

  • Access to your Fortinet device(s)

  • API credentials (token or username/password)

Installing Packages#

Meta Package (All Products)#

Install everything:

pip install hfortix

This installs hfortix-core and all available product packages.

Individual Packages#

Install only what you need:

# Core package only
pip install hfortix-core

# FortiOS/FortiGate
pip install hfortix-fortios

# FortiManager (coming soon)
pip install hfortix-fortimanager

# FortiAnalyzer (coming soon)
pip install hfortix-fortianalyzer

With Optional Dependencies#

# FortiOS with all extras
pip install hfortix[fortios]

Verifying Installation#

import hfortix
print(hfortix.__version__)

# Check specific packages
from hfortix_fortios import FortiOS
from hfortix_core import FortinetError

Upgrading#

# Upgrade all packages
pip install --upgrade hfortix

# Upgrade specific package
pip install --upgrade hfortix-fortios

Uninstalling#

# Remove all HFortix packages
pip uninstall hfortix hfortix-core hfortix-fortios

Next Steps#

Choose your product to get started: