Installation

Requirements

Python 3.8 or higher
pip (Python package installer)

Install from PyPI

The easiest way to install the Switchport SDK is using pip:

pip install switchport

Verify Installation

Verify that the SDK is installed correctly:

import switchport
print(switchport.__version__)

Dependencies

The Switchport SDK has minimal dependencies:

requests - For HTTP requests to the Switchport API

All dependencies are automatically installed when you install the SDK.

Upgrading

To upgrade to the latest version:

pip install --upgrade switchport

Virtual Environments

We recommend using a virtual environment to avoid dependency conflicts:

# Create virtual environment
python -m venv venv

# Activate (Linux/Mac)
source venv/bin/activate

# Activate (Windows)
venv\Scripts\activate

# Install switchport
pip install switchport

# Create conda environment
conda create -n switchport python=3.11

# Activate
conda activate switchport

# Install switchport
pip install switchport

Troubleshooting

Permission Errors

If you get permission errors on Linux/Mac, try:

pip install --user switchport

Or use a virtual environment (recommended).

Python Version Issues

Make sure you’re using Python 3.8 or higher:

python --version

If you have multiple Python versions, you may need to use pip3 instead of pip.

Next Steps

Authentication

Set up your API key and authenticate

Getting Started

Core Features

Examples

Requirements

Install from PyPI

Verify Installation

Dependencies

Upgrading

Virtual Environments

Troubleshooting

Permission Errors

Python Version Issues

Next Steps

Authentication

​Requirements

​Install from PyPI

​Verify Installation

​Dependencies

​Upgrading

​Virtual Environments

​Troubleshooting

​Permission Errors

​Python Version Issues

​Next Steps

Authentication

Requirements

Install from PyPI

Verify Installation

Dependencies

Upgrading

Virtual Environments

Troubleshooting

Permission Errors

Python Version Issues

Next Steps