Skip to main content

Python client for the Extend API

Project description

extend-python

Python library for the Extend API

Python Version License: MIT Code style: black Documentation

A Python client for the Extend API, providing a simple and intuitive interface for managing virtual cards, transactions, and more.

Features

  • Create and manage virtual cards
  • Handle recurring card operations
  • Track transactions
  • Expense management

Documentation

For detailed API documentation, please visit our Stoplight documentation.

Installation

From PyPI

pip install paywithextend

From Source

git clone https://github.com/paywithextend/extend-python.git
cd extend-python
pip install -e .

Quick Start

import asyncio
from extend import ExtendClient


async def main():
    # Initialize the client
    client = ExtendClient(
        api_key="your-api-key",
        api_secret="your-api-secret"
    )

    # Get all virtual cards
    response = await client.virtual_cards.get_virtual_cards()
    print("Virtual Cards:", response["virtualCards"])

    # Get all transactions
    response = await client.transactions.get_transactions()
    print("Transactions:", response["report"]["transactions"])


# Run the async function
asyncio.run(main())

Environment Variables

The following environment variables are required for integration tests and examples:

  • EXTEND_API_KEY: Your Extend API key
  • EXTEND_API_SECRET: Your Extend API secret
  • EXTEND_TEST_RECIPIENT: Email address for test card recipient
  • EXTEND_TEST_CARDHOLDER: Email address for test cardholder

Development Setup

  1. Clone the repository:

    git clone https://github.com/paywithextend/extend-python.git
    cd extend-python
    
  2. Create and activate a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    
  3. Install development dependencies:

    pip install -e ".[dev]"
    
  4. Run tests:

    # Run all tests
    pytest
    
    # Run only unit tests
    pytest tests/test_client.py
    
    # Run only integration tests
    pytest tests/test_integration.py
    

Testing

The project includes both unit tests and integration tests:

  • Unit tests (tests/test_client.py): Test the client's internal logic and validation
  • Integration tests (tests/test_integration.py): Test actual API interactions
  • Example notebook (notebooks/api_testing.ipynb): Interactive examples

To run integration tests, make sure you have set up the required environment variables.

Contributing

We welcome contributions from the community!

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

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

paywithextend-1.1.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

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

paywithextend-1.1.0-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file paywithextend-1.1.0.tar.gz.

File metadata

  • Download URL: paywithextend-1.1.0.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for paywithextend-1.1.0.tar.gz
Algorithm Hash digest
SHA256 2088cc242e8927982f0045b7f9382f97f117f36556b986b1f2ee08784dbb392c
MD5 09a41d54711d0c0c19e9b68960e9703e
BLAKE2b-256 53fd977f8189f13d47ae6b21ad8ce15d0073ba8ed20bb72a193c62176f91f72d

See more details on using hashes here.

File details

Details for the file paywithextend-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: paywithextend-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 22.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for paywithextend-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e39b8f192b4de89de7cefa5967295792def37224c30daa29f4d3c9f2cc05a5d
MD5 243fbe616579b0cdabf73affa677ae71
BLAKE2b-256 7501b60ca39dbe835617e4df53651450ef2e7a2bf38da0eb31e3db0d7cb9d874

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