# Fax.Plus Python SDK
<p>
<h4>Made for third-party developers and organizations to send and receive faxes from their own software or application.</h4>
<p>
<a href="#"><img src="https://img.shields.io/pypi/v/faxplus-api?style=flat-square" alt="NPM version"></img></a>
<img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License">
</p>
</p>
<p>
<a href="https://apidoc.fax.plus" target="_blank">API Documentation</a> •
<a href="https://www.fax.plus" target="_blank">Home</a> •
<a href="https://www.fax.plus/help/" target="_blank">Help Center</a> •
<a href="https://www.fax.plus/contact-us/" target="_blank">Contact Us</a>
</p>
- Only available to [Enterprise](https://www.fax.plus/pricing/) clients
## Requirements.
Python 3.5+
## Installation
### pip install
To install the package from PyPi
```sh
# From PyPi
pip install faxplus-api
# Directly from Github
pip install git+https://github.com/alohi/faxplus-python.git
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
git clone https://github.com/alohi/faxplus-python.git
cd faxplus-python
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
## Getting Started
Example usage:
```python
from faxplus import ApiClient, Configuration, FaxesApi
configuration = Configuration()
configuration.access_token = "YOUR_ACCESS_TOKEN"
client = ApiClient(configuration)
api = FaxesApi()
faxes = api.list_faxes("self", category=FaxCategory.INBOX)
```
## Documentation
Visit the full API reference at [apidoc.fax.plus](https://apidoc.fax.plus).
## Author
© 2024 Alohi (Geneva, Switzerland) - [Alohi.com](https://alohi.com)
Raw data
{
"_id": null,
"home_page": "https://github.com/alohi/faxplus-python",
"name": "faxplus-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Swagger, Fax.Plus REST API",
"author": "Alohi SA",
"author_email": "info@fax.plus",
"download_url": null,
"platform": null,
"description": "# Fax.Plus Python SDK\n\n<p>\n <h4>Made for third-party developers and organizations to send and receive faxes from their own software or application.</h4>\n <p>\n <a href=\"#\"><img src=\"https://img.shields.io/pypi/v/faxplus-api?style=flat-square\" alt=\"NPM version\"></img></a>\n <img src=\"https://img.shields.io/badge/license-MIT-green.svg?style=flat-square\" alt=\"License\">\n </p>\n</p>\n\n<p>\n <a href=\"https://apidoc.fax.plus\" target=\"_blank\">API Documentation</a> \u2022\n <a href=\"https://www.fax.plus\" target=\"_blank\">Home</a> \u2022\n <a href=\"https://www.fax.plus/help/\" target=\"_blank\">Help Center</a> \u2022\n <a href=\"https://www.fax.plus/contact-us/\" target=\"_blank\">Contact Us</a>\n</p>\n\n- Only available to [Enterprise](https://www.fax.plus/pricing/) clients\n\n## Requirements.\n\nPython 3.5+\n\n## Installation\n### pip install\n\nTo install the package from PyPi\n\n```sh\n# From PyPi\npip install faxplus-api\n\n# Directly from Github\npip install git+https://github.com/alohi/faxplus-python.git\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\ngit clone https://github.com/alohi/faxplus-python.git\ncd faxplus-python\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\n## Getting Started\n\nExample usage:\n\n```python\nfrom faxplus import ApiClient, Configuration, FaxesApi\n\nconfiguration = Configuration()\nconfiguration.access_token = \"YOUR_ACCESS_TOKEN\"\nclient = ApiClient(configuration)\napi = FaxesApi()\nfaxes = api.list_faxes(\"self\", category=FaxCategory.INBOX)\n```\n\n## Documentation\nVisit the full API reference at [apidoc.fax.plus](https://apidoc.fax.plus).\n\n## Author\n\u00a9 2024 Alohi (Geneva, Switzerland) - [Alohi.com](https://alohi.com)\n",
"bugtrack_url": null,
"license": null,
"summary": "Fax.Plus REST API",
"version": "3.0.4",
"project_urls": {
"Homepage": "https://github.com/alohi/faxplus-python"
},
"split_keywords": [
"swagger",
" fax.plus rest api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "36d830e2dbeefec1cef852e950ef961dca5b811fb564e76122e7f5ece18f145e",
"md5": "1b8c266b0292a500be0f633f61edc7f1",
"sha256": "f2554ae36f28fc51c3fcb13ea5ebeb769516bc3942c0ef1c8a235448e3f45622"
},
"downloads": -1,
"filename": "faxplus_api-3.0.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b8c266b0292a500be0f633f61edc7f1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 109526,
"upload_time": "2024-03-20T15:20:20",
"upload_time_iso_8601": "2024-03-20T15:20:20.430090Z",
"url": "https://files.pythonhosted.org/packages/36/d8/30e2dbeefec1cef852e950ef961dca5b811fb564e76122e7f5ece18f145e/faxplus_api-3.0.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-20 15:20:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alohi",
"github_project": "faxplus-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "certifi",
"specs": [
[
">=",
"14.05.14"
]
]
},
{
"name": "six",
"specs": [
[
">=",
"1.10"
]
]
},
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.5.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"21.0.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.15.1"
]
]
}
],
"lcname": "faxplus-api"
}
JSON
