depoc 0.1.6a1

Python bindings for the Depoc API

Depoc API Python Library

This library simplifies interaction with the Depoc API. It enables convenient HTTP requests - retrieving, creating, updating, and deleting resources.

It also ships with a CLI, exposed via the depoc command, which is documented in a later section.

Note: This library is under active development and may contain breaking changes or unresolved issues.

Installation

Install via pip

$ pip install depoc

Getting Started

The library requires your account's access token for authentication.

Currently, the only supported method to get your token is to instantiate the Connection class with your username and password.

from depoc import Connection

user = Connection(username="foo", password="bar")

# returns the account's access token
user.token

Usage

You're now ready to start using the library. Instatiate the DepocClient class with the access token you just got.

from depoc import DepocClient

client = DepocClient(user.token)

# Retrieve all customers
customers = client.customer.all()

# Retrieve an specific customer
customer = client.customer.get('ID-KLSJDF331')

Handling Exceptions

Requirements

• Python 3.12+

Third Party Libraries and Dependencies

The following libraries will be installed when you install the Depoc API library:

• requests
• appdirs
• click
• rich

CLI

Installing the Depoic API Python library provides access to the depoc command. Before using the Depoc CLI, you must configure your credentials by running the depoc login command.

$ depoc login
Username: foo
Password: bar

CLI Usage

depoc [command]

# Run `--help` for detailed information about the CLI commands
depoc [command] --help

Commands

The Depoc CLI supports a broad number of commands. Bellow are some of the most used ones:

• me
• login
• logout
• account
• customer
• transaction
• bank
• payable
• receivable

Command Output

The default output is a box layout rendered with Rich for improved readability.

$ depoc bank 
╭─ ANY BANK ──────────────────────────────────────────────────╮
│                                                $10,374.12   │
│                                                             │
│ 01JN7MFR675GASDKFLJW31N22V                                  │
╰─────────────────────────────────────────────────────────────╯   
╭─ THE SECOND BANK ───────────────────────────────────────────╮
│                                                    $744.89  │
│                                                             │
│ 02JNLSKFJALSDKJFSALVKR962V                                  │
╰─────────────────────────────────────────────────────────────╯   
╭─ BANK ONE ──────────────────────────────────────────────────╮
│                                                      $2.53  │
│                                                             │
│ 03JN7MFR675G1SJLKDFJ20923J                                  │
╰─────────────────────────────────────────────────────────────╯

Total Balance: $11,121.54