# FreshBooks Python SDK
[](https://pypi.org/project/freshbooks-sdk/)

[](https://github.com/amcintosh/freshbooks-python-sdk/actions?query=workflow%3A%22Run+Tests%22)
The FreshBooks Python SDK allows you to more easily utilize the [FreshBooks API](https://www.freshbooks.com/api).
## Installation
```bash
pip install freshbooks-sdk
```
## Usage
See the [full documentation](https://freshbooks-python-sdk.readthedocs.io/) or check out some of our [examples](https://github.com/amcintosh/freshbooks-python-sdk/tree/main/examples).
## Development
### Testing
To run all tests:
```bash
make test
```
To run a single test with pytest:
```bash
py.test path/to/test/file.py
py.test path/to/test/file.py::TestClass::test_case
```
### Documentations
You can generate the documentation via:
```bash
make generate-docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/amcintosh/freshbooks-python-sdk",
"name": "freshbooks-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "FreshBooks",
"author": "Andrew McIntosh",
"author_email": "andrew@amcintosh.net",
"download_url": "https://files.pythonhosted.org/packages/3f/a4/d3648773d7f18ef6d6193cfa666e71649f3d0959f99a2470df3276e9f675/freshbooks_sdk-1.3.0.tar.gz",
"platform": null,
"description": "# FreshBooks Python SDK\n\n[](https://pypi.org/project/freshbooks-sdk/)\n\n[](https://github.com/amcintosh/freshbooks-python-sdk/actions?query=workflow%3A%22Run+Tests%22)\n\nThe FreshBooks Python SDK allows you to more easily utilize the [FreshBooks API](https://www.freshbooks.com/api).\n\n## Installation\n\n```bash\npip install freshbooks-sdk\n```\n\n## Usage\n\nSee the [full documentation](https://freshbooks-python-sdk.readthedocs.io/) or check out some of our [examples](https://github.com/amcintosh/freshbooks-python-sdk/tree/main/examples).\n\n## Development\n\n### Testing\n\nTo run all tests:\n\n```bash\nmake test\n```\n\nTo run a single test with pytest:\n\n```bash\npy.test path/to/test/file.py\npy.test path/to/test/file.py::TestClass::test_case\n```\n\n### Documentations\n\nYou can generate the documentation via:\n\n```bash\nmake generate-docs\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "API client for FreshBooks",
"version": "1.3.0",
"project_urls": {
"Download": "https://github.com/amcintosh/freshbooks-python-sdk/archive/release/1.3.0.tar.gz",
"Homepage": "https://github.com/amcintosh/freshbooks-python-sdk"
},
"split_keywords": [
"freshbooks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2dcc725047383773734e9c0f87e7af5cae47ca054f701901c8a7c1d26350573f",
"md5": "5ad5053066dd293ca1c2709f78b7aa12",
"sha256": "591e27fb3a8a93b85e14006ea22c5416ea0916cfc236e55eda0e9609251fc8e2"
},
"downloads": -1,
"filename": "freshbooks_sdk-1.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5ad5053066dd293ca1c2709f78b7aa12",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 30539,
"upload_time": "2024-10-08T20:02:51",
"upload_time_iso_8601": "2024-10-08T20:02:51.483853Z",
"url": "https://files.pythonhosted.org/packages/2d/cc/725047383773734e9c0f87e7af5cae47ca054f701901c8a7c1d26350573f/freshbooks_sdk-1.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3fa4d3648773d7f18ef6d6193cfa666e71649f3d0959f99a2470df3276e9f675",
"md5": "2e7aa253bf551b273fdc0a1a9ecceb30",
"sha256": "62da562158569ae1abc3511bc0373ab563dd270012dafe9f03d7d2814d17e9ec"
},
"downloads": -1,
"filename": "freshbooks_sdk-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "2e7aa253bf551b273fdc0a1a9ecceb30",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32436,
"upload_time": "2024-10-08T20:02:52",
"upload_time_iso_8601": "2024-10-08T20:02:52.385178Z",
"url": "https://files.pythonhosted.org/packages/3f/a4/d3648773d7f18ef6d6193cfa666e71649f3d0959f99a2470df3276e9f675/freshbooks_sdk-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 20:02:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "amcintosh",
"github_project": "freshbooks-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "freshbooks-sdk"
}