Skip to main content

Python client for 3CX HTTP APIs with Alkivi config integration

Project description

threecx

Python client for 3CX HTTP APIs with configuration handled via Alkivi's config manager.

Installation

pip install threecx

Configuration

Configuration is provided by python-alkivi-config-manager. See its repository for details: alkivi-sas/python-alkivi-config-manager.

Create a configuration file named 3cx.conf in one of the supported locations (./3cx.conf, ~/.3cx.conf, /etc/3cx.conf):

[default]
endpoint=prod

[prod]
fqdn=pbx.example.com
username=john
password=secret

Usage

from threecx import get_3cx_api

client = get_3cx_api("prod")
print(client.version())

Or list configured endpoints:

from threecx import get_3cx_endpoints

print(get_3cx_endpoints())

Development

  • Build: python -m build (requires pip install build)
  • Test: pytest

License

MIT

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

threecx-0.1.0.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

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

threecx-0.1.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file threecx-0.1.0.tar.gz.

File metadata

  • Download URL: threecx-0.1.0.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for threecx-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d8bf5ba0d68a6acfcffeb5e422ba7fc7bd544dc7347ec2130e36571362f1f6a8
MD5 38e34d2c567df826dc3117c596510ffa
BLAKE2b-256 24488d40cc2bcaff8503ce56b67ac7f9c907bcfa9d6e6d4cbba9ea3d2563ae99

See more details on using hashes here.

File details

Details for the file threecx-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: threecx-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for threecx-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 44ccfb88991fbcd6135e22f0d38884fbac39cf40812611f16fcc8898c777605f
MD5 01ce0b3bc1979e4feae3ba9ba2867c67
BLAKE2b-256 a55af643e608f7677ed9864dcaf58368788b8f79aeef8a7f90ea9460bf801754

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