Method Python SDK

2.1.1 · active · verified Sat Apr 11

The `method-python` library is an official Python client for interacting with the Method API. It provides convenient access to the Method platform's financial services, allowing developers to integrate banking and payment functionalities into their applications. Currently at version 2.1.1, the library is actively maintained with regular updates, including both minor feature enhancements and major version releases.

Warnings

breaking Major version `v2.0.0` was released without explicit breaking changes detailed in the GitHub release notes. As with any major version bump, it is highly recommended to review the project's changelog (if available on the GitHub repository or official documentation) before upgrading to understand potential API changes, deprecations, or behavioral shifts that might affect your existing codebase.
Fix: Thoroughly test your application when upgrading from `v1.x.x` to `v2.x.x`. Consult the official Method API documentation and any available changelog/migration guides for specific changes.
breaking Version `v1.2.0` mentioned that it 'Addressed breaking change in v1.1.13'. This indicates that breaking changes might have been introduced in `v1.1.13` and subsequently resolved or adapted in `v1.2.0`. Users on versions older than `v1.2.0` should be aware of potential API instability or necessary adjustments if upgrading through this range.
Fix: If migrating from versions prior to `v1.2.0`, check the specific changes around `v1.1.13` to `v1.2.0` in the project's history or documentation to understand the required code adjustments.
gotcha API keys and sensitive credentials should never be hardcoded directly into your source code. Exposing API keys can lead to unauthorized access to your Method account and financial data.
Fix: Always store your `api_key` in environment variables (e.g., `METHOD_API_KEY`) and load it into your application at runtime. Use `os.environ.get('METHOD_API_KEY')` for secure retrieval.
gotcha The `Method` client initialization allows for an optional `base_url` parameter (added in v2.1.0) to override the default Method API endpoint. While useful for testing or custom deployments, ensure you are pointing to the correct and secure Method API endpoint for production environments to avoid unexpected behavior or security issues.
Fix: Only override `base_url` when necessary (e.g., local development, staging environments). For production, rely on the library's default endpoint or ensure the custom `base_url` is the official Method production API endpoint.

Install

pip install method-python Install stable version

Imports

Method
```
from method import Method
```
The primary class for interacting with the Method API.

Quickstart

This quickstart demonstrates how to initialize the `Method` client. It's crucial to securely manage your API key, preferably using environment variables. After initialization, you can use the `method` object to access various API endpoints as defined by the Method API documentation.

import os
from method import Method

# Initialize the Method client with your API key from an environment variable
# It is highly recommended to use environment variables for sensitive data like API keys.
api_key = os.environ.get('METHOD_API_KEY', 'YOUR_API_KEY_HERE')

# Initialize Method client for production environment
# Replace 'YOUR_API_KEY_HERE' with a placeholder or ensure it's loaded from env
method = Method(env='production', api_key=api_key)

# Example: List entities (replace with actual API call based on Method API docs)
try:
    # This is a placeholder; consult Method API documentation for actual endpoints
    # For instance, if there's a way to list all entities:
    # entities = method.entities.list()
    # print(f"Found {len(entities)} entities.")
    # print(entities)
    print("Method client initialized successfully. Consult API docs for specific calls.")
except Exception as e:
    print(f"An error occurred: {e}")

view raw JSON →