# billingplatform-py
Welcome! This is a community-driven Python library for interacting with BillingPlatform APIs! This project aims to provide a comprehensive and easy-to-use interface for developers working with BillingPlatform.
## Installation
You can install the library using pip:
```bash
pip install billingplatform
```
## Usage
While still under active development towards version 1.0, you can start using the library for its current functionality. Here's a basic example:
```python
from billingplatform import BillingPlatform
# Initialize the API client (creates the session)
# Just in case it has to be said, don't hardcode your credentials in production code ;-)
bp = BillingPlatform(base_url="https://sandbox.billingplatform.com/myorg", username="myuser", password="mypassword")
# Fetch a list of accounts
try:
response: dict = bp.query(sql="SELECT Id, Name, Status FROM ACCOUNT WHERE 1=1")
accounts: list[dict] = response.get("queryResponse", []) # Strip out data from response
for account in accounts:
print(account)
except Exception as e:
print(f"An error occurred: {e}")
```
Please note: The available methods and their functionalities are still being expanded. Refer to the [documentation](docs/README.md), source code, or tests for the most up-to-date usage examples.
## Contributions
This is a community-driven project, and we welcome contributions! Whether you're fixing a bug, adding a new feature, improving documentation, or suggesting enhancements, your input is valuable.
If you encounter any issues or have suggestions, please don't hesitate to open an issue on our GitHub Issues page and fork the repository and create a pull request.
We're excited to have you as part of our community as we work towards a robust and complete version 1.0
Raw data
{
"_id": null,
"home_page": null,
"name": "billingplatform",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "billingplatform, rest api, billing, revenue management",
"author": null,
"author_email": "forgineer <blake.phillips86@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/bd/81/697ef7b63194c0611f07f945be8c8eb86ee79a7c058cfa0084e8be3d9347/billingplatform-0.2.0.tar.gz",
"platform": null,
"description": "# billingplatform-py\r\n\r\nWelcome! This is a community-driven Python library for interacting with BillingPlatform APIs! This project aims to provide a comprehensive and easy-to-use interface for developers working with BillingPlatform.\r\n\r\n## Installation\r\n\r\nYou can install the library using pip:\r\n\r\n```bash\r\npip install billingplatform\r\n```\r\n\r\n## Usage\r\n\r\nWhile still under active development towards version 1.0, you can start using the library for its current functionality. Here's a basic example:\r\n\r\n```python\r\nfrom billingplatform import BillingPlatform\r\n\r\n# Initialize the API client (creates the session)\r\n# Just in case it has to be said, don't hardcode your credentials in production code ;-)\r\nbp = BillingPlatform(base_url=\"https://sandbox.billingplatform.com/myorg\", username=\"myuser\", password=\"mypassword\")\r\n\r\n# Fetch a list of accounts\r\ntry:\r\n response: dict = bp.query(sql=\"SELECT Id, Name, Status FROM ACCOUNT WHERE 1=1\")\r\n accounts: list[dict] = response.get(\"queryResponse\", []) # Strip out data from response\r\n\r\n for account in accounts:\r\n print(account)\r\nexcept Exception as e:\r\n print(f\"An error occurred: {e}\")\r\n```\r\n\r\nPlease note: The available methods and their functionalities are still being expanded. Refer to the [documentation](docs/README.md), source code, or tests for the most up-to-date usage examples.\r\n\r\n## Contributions\r\n\r\nThis is a community-driven project, and we welcome contributions! Whether you're fixing a bug, adding a new feature, improving documentation, or suggesting enhancements, your input is valuable.\r\n\r\nIf you encounter any issues or have suggestions, please don't hesitate to open an issue on our GitHub Issues page and fork the repository and create a pull request.\r\n\r\nWe're excited to have you as part of our community as we work towards a robust and complete version 1.0\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A community driven Python library for working with BillingPlatform APIs.",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://github.com/forgineer/billingplatform-py",
"Homepage": "https://github.com/forgineer/billingplatform-py",
"Issues": "https://github.com/forgineer/billingplatform-py/issues",
"Repository": "https://github.com/forgineer/billingplatform-py"
},
"split_keywords": [
"billingplatform",
" rest api",
" billing",
" revenue management"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9584b0e37af0ce5ab30642219c07d7835ae956da4656823b2ab93191937ddf2f",
"md5": "fded8fdecf4b4f33bac5e09f1582478f",
"sha256": "e41ef4495168d2567eb020f54d2bf86e2a496b7d14fae1c8aafb366e1a9059bc"
},
"downloads": -1,
"filename": "billingplatform-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fded8fdecf4b4f33bac5e09f1582478f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 11990,
"upload_time": "2025-07-17T03:37:49",
"upload_time_iso_8601": "2025-07-17T03:37:49.167876Z",
"url": "https://files.pythonhosted.org/packages/95/84/b0e37af0ce5ab30642219c07d7835ae956da4656823b2ab93191937ddf2f/billingplatform-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "bd81697ef7b63194c0611f07f945be8c8eb86ee79a7c058cfa0084e8be3d9347",
"md5": "57cf234d80d5e04d8ac18d8745c39c2a",
"sha256": "a53712c0a0f41c3a929b2865576dbccf8c2563c0129b9cba8defb7029b2bee82"
},
"downloads": -1,
"filename": "billingplatform-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "57cf234d80d5e04d8ac18d8745c39c2a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 14120,
"upload_time": "2025-07-17T03:37:49",
"upload_time_iso_8601": "2025-07-17T03:37:49.993428Z",
"url": "https://files.pythonhosted.org/packages/bd/81/697ef7b63194c0611f07f945be8c8eb86ee79a7c058cfa0084e8be3d9347/billingplatform-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-17 03:37:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "forgineer",
"github_project": "billingplatform-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "billingplatform"
}
JSON
