Skip to main content

A Python library that takes the LeadPerfection API methods and packages them in an easy-to-use format

Project description

lead-perfection

lead-perfection is a Python library that provides a simple interface for interaction with LeadPerfection methods, packaging them into an easy-to-use format. It abstracts authentication, request formatting, and endpoint access to make LeadPerfection integrations easier for developers building automations, backend services, and CRM tooling.

Benefits & Features

  • Simple authentication workflow
  • Organized client and module structure (client, customers, leads, etc.)
  • Reduces need to write boilerplate requests for LeadPerfection API calls

Installation

pip install lead-perfection

Usage Example

Here is a real-world example based on the library's example.py.
Replace the credential values with your own LeadPerfection environment details.

import lead_perfection as lp

# Initialize the client
# Update each argument with your actual LeadPerfection credentials
client = lp.client.Client(
    'apitest',                          # server_id
    'demo3',                            # client_id
    'demo3api',                         # username
    'LP3api123!',                       # password
    '4E405C4F-6EAA-4A7F-A0AE-5B955B1FD2F1'  # app_key
)

# Authenticate and retrieve an access token
auth_data = client.authenticate()
access_token = auth_data['access_token']
print("Access Token:", access_token)

# Access the Menu endpoint using the obtained token
lp_menu = lp.menu.Menu(server_id='apitest', access_token=access_token)
menu_result = lp_menu.get_menu()

print("Menu Result:", menu_result)

# Access the Leads endpoint using the obtained token
lp_leads = lp.leads.Leads(server_id='apitest', access_token=access_token)
leads_result = lp_leads.leads_login_message()

print("Leads Login Message Result:", leads_result)

Project Structure

  • canvass.py — Wrapper for all canvass-related API calls
  • client.py — Handles authentication with the LeadPerfection API
  • custom.py - Wrapper for custom API calls
  • customers.py - Wrapper for all customer-related API calls
  • downloads.py - Wrapper for all download-related API calls
  • file.py - Wrapper for all file-related API calls
  • installer.py - Wrapper for all installer-related API calls
  • leads.py — Wrapper for all lead-related API calls
  • menu.py — Wrapper for all menu-related API calls
  • sales.py - Wrapper for all sales-related API calls
  • utils.py - Abstraction for http requests and header setup

Extending the Library

lead-perfection is structured so you can easily add new endpoint wrappers:

  • Create a new module file (e.g., appointments.py)
  • Implement functions that call the appropriate LeadPerfection API paths

Requirements

  • Python 3.8+

License

This project is licensed under the MIT License.

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lead_perfection-1.0.0.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lead_perfection-1.0.0-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file lead_perfection-1.0.0.tar.gz.

File metadata

  • Download URL: lead_perfection-1.0.0.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for lead_perfection-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8d0d1bed354a9ad550ab9944ca06a65f5aade8430b9d38e98d96501dfd617ae2
MD5 3ff6ad4b7637414ccf80794ef8cc71a2
BLAKE2b-256 128ab764d33fa35a34e4b5c27b03c29091bc1468f7c316ca2bb373a1c77121ff

See more details on using hashes here.

File details

Details for the file lead_perfection-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for lead_perfection-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30bd63508dcb605e483542f5f69be3de86076d75f612134dd4bcc664ba3854ea
MD5 b1166733d0fa2d526bf756c3b200a828
BLAKE2b-256 224a3df03e52567c469caf405635b6e7f1037216bc636dec8af46a7b68ae0efe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page