sftpgo-client 0.2.0

Python client for the SFTPGo API

sftpgo-client

Python client for the SFTPGo API

The sftpgo_client.base package is automatically generated from the OpenAPI specification provided by SFTPGo using openapi-python-client.

Installation

pip install sftpgo-client

Examples

from sftpgo_client import Client

client = Client(
    base_url="http://localhost:8080/api/v2", user="admin", password="password"
)
users = client.get_users()
for user in users:
    print(user.username)

Using the asynchronous client:

import asyncio

from sftpgo_client import AsyncClient


async def print_usernames():
    client = AsyncClient(
        base_url="http://localhost:8080/api/v2", user="admin", password="password"
    )
    users = await client.get_users()
    for user in users:
        print(user.username)


asyncio.run(print_usernames())

Development

You can fetch the latest version of the SFTPGo OpenAPI specification and update sftpgo_client.base with:

./generator/run.sh