# Bitrix24 REST API for Python
Easy way to communicate with bitrix24 portal over REST without OAuth 2.0
## Description
Bitrix24 REST is an API wrapper for working with Bitrix24 REST API over webhooks.
No OAuth 2.0 required. It's easy to use and super lightweight, with minimal dependencies.
## Features
- Works with both cloud and on-premises versions of Bitrix24.
- Super easy to setup. No OAuth 2.0 infrastructure required.
- Built with data analysis in mind and fully compatible with Jupyter Notebook.
- Fetch paginated data at once without hassle.
- Works with large datasets and handles rate limits.
## Installation
```
pip install bitrix24-rest
```
## Quickstart
```python
from bitrix24 import Bitrix24
bx24 = Bitrix24('https://example.bitrix24.com/rest/1/33olqeits4avuyqu')
print(bx24.callMethod('crm.product.list'))
```
In async mode:
```python
import asyncio
from bitrix24 import bitrix24
async def main():
bx24 = Bitrix24('https://example.bitrix24.com/rest/1/33olqeits4avuyqu')
result = await bx24.callMethod('crm.product.list')
print(result)
asyncio.run(main())
```
## Advanced usage
- [Using filters and additional parameters](docs/using-filters-and-additional-parameters.md)
- [Working with large datasets](docs/working-with-large-datasets.md)
- [Disabling certificate verification](docs/disabling-certificate-verification.md)
## Notes
List methods return all available items at once. For large collections of data use limits.
## Development
New contributers and pull requests are welcome. If you have any questions or suggestions, feel free to open an issue.
Code comes with makefile for easy code base management. You can check `make help` for more details.
```sh
make init install # to create a local virtual environment and install dependencies
make test # to run tests
make lint # to run linter
```
I suggest to use `make all` before committing your changes as it will run all the necessary checks.
## Support this project
You can support this project by starring ⭐, sharing 📤, and contributing.
You can also support the author by buying him a coffee ☕. Click sponsor button on the top of the page.
Raw data
{
"_id": null,
"home_page": "https://github.com/akopdev/bitrix24-python-rest",
"name": "bitrix24-rest",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "bitrix24 api rest",
"author": "Akop Kesheshyan",
"author_email": "hello@akop.dev",
"download_url": "https://files.pythonhosted.org/packages/1d/bc/2d18f6074775726e9257c62c9d081cb2878ed86ee6b425ca343abfc758aa/bitrix24_rest-2.0.0.tar.gz",
"platform": null,
"description": "# Bitrix24 REST API for Python\n\nEasy way to communicate with bitrix24 portal over REST without OAuth 2.0\n\n## Description\n\nBitrix24 REST is an API wrapper for working with Bitrix24 REST API over webhooks.\nNo OAuth 2.0 required. It's easy to use and super lightweight, with minimal dependencies.\n\n## Features\n\n- Works with both cloud and on-premises versions of Bitrix24.\n- Super easy to setup. No OAuth 2.0 infrastructure required.\n- Built with data analysis in mind and fully compatible with Jupyter Notebook.\n- Fetch paginated data at once without hassle.\n- Works with large datasets and handles rate limits.\n\n## Installation\n\n```\npip install bitrix24-rest\n```\n\n## Quickstart\n\n```python\nfrom bitrix24 import Bitrix24\n\nbx24 = Bitrix24('https://example.bitrix24.com/rest/1/33olqeits4avuyqu')\n\nprint(bx24.callMethod('crm.product.list'))\n```\n\nIn async mode:\n\n```python\nimport asyncio\nfrom bitrix24 import bitrix24\n\nasync def main():\n bx24 = Bitrix24('https://example.bitrix24.com/rest/1/33olqeits4avuyqu')\n result = await bx24.callMethod('crm.product.list')\n print(result)\n\nasyncio.run(main())\n```\n\n## Advanced usage\n\n- [Using filters and additional parameters](docs/using-filters-and-additional-parameters.md)\n- [Working with large datasets](docs/working-with-large-datasets.md)\n- [Disabling certificate verification](docs/disabling-certificate-verification.md)\n\n## Notes\n\nList methods return all available items at once. For large collections of data use limits.\n\n## Development\n\nNew contributers and pull requests are welcome. If you have any questions or suggestions, feel free to open an issue.\n\nCode comes with makefile for easy code base management. You can check `make help` for more details.\n\n```sh\nmake init install # to create a local virtual environment and install dependencies\n\nmake test # to run tests\n\nmake lint # to run linter\n```\n\nI suggest to use `make all` before committing your changes as it will run all the necessary checks.\n\n## Support this project\n\nYou can support this project by starring \u2b50, sharing \ud83d\udce4, and contributing. \n\nYou can also support the author by buying him a coffee \u2615. Click sponsor button on the top of the page.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Easy way to communicate with bitrix24 portal over REST without OAuth",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/akopdev/bitrix24-python-rest"
},
"split_keywords": [
"bitrix24",
"api",
"rest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "39db5e0f98ae7e8870a44ca2fb124f998cf54259a942860dba44523450df78f5",
"md5": "c87a7a7ec0f027df14177684d6732c7a",
"sha256": "ad7a1f647d9db0c10389a252d0d41b19d4ebda8263ef61398e87452d7da145bb"
},
"downloads": -1,
"filename": "bitrix24_rest-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c87a7a7ec0f027df14177684d6732c7a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9055,
"upload_time": "2024-04-14T00:50:41",
"upload_time_iso_8601": "2024-04-14T00:50:41.228244Z",
"url": "https://files.pythonhosted.org/packages/39/db/5e0f98ae7e8870a44ca2fb124f998cf54259a942860dba44523450df78f5/bitrix24_rest-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1dbc2d18f6074775726e9257c62c9d081cb2878ed86ee6b425ca343abfc758aa",
"md5": "25f19d35a51577922b223d412ea88164",
"sha256": "d4dd54acbf11c51b21464981d56e40e8aaa297d488e3c7de2f639d32a867e28f"
},
"downloads": -1,
"filename": "bitrix24_rest-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "25f19d35a51577922b223d412ea88164",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6742,
"upload_time": "2024-04-14T00:50:42",
"upload_time_iso_8601": "2024-04-14T00:50:42.881994Z",
"url": "https://files.pythonhosted.org/packages/1d/bc/2d18f6074775726e9257c62c9d081cb2878ed86ee6b425ca343abfc758aa/bitrix24_rest-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-14 00:50:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "akopdev",
"github_project": "bitrix24-python-rest",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "bitrix24-rest"
}
JSON
