ABConnect Documentation

ABConnect is a Python package for Annex Brands data processing and API interactions.

Getting Started:

• Installation
  • Requirements
  • Installing from PyPI
  • Development Installation
  • Environment Configuration
  • Django Integration
• Quick Start Guide
  • Basic Usage
  • Using the Builder
  • Using the Loader
  • Using the Quoter
  • Error Handling
  • Next Steps
• CLI Quick Start
  • Prerequisites
  • First Steps
  • Common Tasks
  • Output Formats
  • Environment Control
  • Quick Examples
  • Next Steps
  • Getting Help

Command Line Interface:

• Command Line Interface
  • Installation
  • Environment Setup
  • Available Commands
  • Common Workflows
  • Environment Variables
  • Troubleshooting
  • See Also
• CLI Examples
  • Quick Start Examples
  • Working with Companies
  • Working with Jobs
  • Lookup Operations
  • File Operations
  • Quote Operations
  • Advanced Usage
  • Environment Management
  • Scripting Examples
  • Error Handling
  • Integration Examples
  • See Also

Python Library:

• API Reference
  • API Access Methods
  • Authentication
  • API Client
  • Generic Endpoints
  • Query Builder
  • Swagger Parser
  • Response Models
  • Endpoints
  • HTTP Client
  • Exceptions
• Modules
  • Builder Module
  • Loader Module
  • Quoter Module
  • API Module
• Python Library Examples
  • Quick Start Examples
  • Working with Companies
  • Working with Jobs
  • Lookup Values
  • File Operations
  • Quoting
  • Error Handling
  • Pagination
  • Advanced Usage
  • Environment Configuration
  • Django Integration
  • Using Generic Endpoints
  • See Also

API Documentation:

• Endpoint Reference
  • Available Resources
• API Models
  • Address Models
  • Company Models
  • Contact Models
  • Document Models
  • Form Models
  • Job Models
  • Lookup Models
  • User Models
  • Overview
  • Model Categories
  • Usage Example
  • Cross-References

Reference:

• Changelog
  • Changelog

Overview

ABConnect provides a comprehensive set of tools for interacting with the Annex Brands ABC API. The package is structured around four main modules:

• Builder: Dynamically constructs API requests from static JSON templates

• Quoter: Handles ABC API quote operations with Quick Quote and Quote Request modes

• Loader: Provides robust file loading for CSV, JSON, and XLSX formats

• API: Full-featured API client with endpoint-specific classes

Key Features

• Automatic access to all 223+ API endpoints via generic endpoint system

• Fluent query builder for complex API queries

• Pydantic models for type-safe API responses

• Template-based request construction

• Flexible authentication with token storage

• Support for both staging and production environments

• Comprehensive API endpoint coverage

• Automatic encoding detection for file loading

• Django compatibility for session-based authentication

Requirements

• Python 3.11 or higher

• See pyproject.toml for full dependency list

Indices and tables

• Index

• Module Index

• Search Page