| Name | betfair-parser JSON |
| Version |
0.14.1
JSON |
| download |
| home_page | https://github.com/limx0/betfair_parser |
| Summary | A betfair parser |
| upload_time | 2025-01-11 06:42:27 |
| maintainer | None |
| docs_url | None |
| author | Bradley McElroy |
| requires_python | >=3.10 |
| license | Copyright 2023, betfair_parser developers Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
parser
betfair
api
json
streaming
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/limx0/betfair_parser/actions)
[](https://pypi.org/project/betfair_parser/)
[](https://github.com/psf/black)
# betfair_parser
A simple and fast betfair parser. Why you might like this library:
- Complete: All betfair (non-vendor) client API included
- Conventions: The API strictly follows pythonic naming conventions
- Consistency: All data is type checked, API requests as well as responses
- Comfort: All betfair enums and type definitions are included, to support IDE syntax completion
- Clear errors: API errors don't just throw cryptic codes, but contain documentation about that error
- Compatible: Use it with any HTTP library you like, including async libraries
- Cheetah fast: Thanks to the magic of [msgspec](https://github.com/jcrist/msgspec), megabytes of input
parse in milliseconds
## Usage
`betfair_parser` is built out of API building blocks, that can be used with any HTTP client
you like. All API operations provide `.headers()`, `.body()` and a `.parse_response()` method.
The [`client`](https://github.com/limx0/betfair_parser/blob/main/betfair_parser/client.py) module
contains a sample, minimalistic client implementation. It may be used as is with any `requests`-compatible
HTTP client or serve as an example, how to integrate `betfair_parser` with other HTTP clients.
```python
import requests
from betfair_parser import client
from betfair_parser.spec import accounts, betting
session = requests.Session() # or anything similar like httpx.Client()
client.login(session, "username", "password", "app_key")
client.request(session, accounts.GetAccountFunds.with_params())
# AccountFundsResponse(available_to_bet_balance=10000.0, exposure=0.0,
# retained_commission=0.0, exposure_limit=-10000.0, discount_rate=0.0,
# points_balance=10, wallet=<Wallet.UK: 'UK'>)
# Request with an invalid wallet parameter:
client.request(session, accounts.GetAccountFunds.with_params(wallet="AUS"))
# >>> AccountAPINGException: INVALID_PARAMETERS: Problem parsing the parameters,
# or a mandatory parameter was not found
client.request(session, betting.ListCurrentOrders.with_params())
# CurrentOrderSummaryReport(current_orders=[], more_available=False)
# Support for other countries
from betfair_parser.endpoints import endpoint
endpoint_cfg = endpoint("ITA") # alpha-3 code
client.login(session, "username", "password", "app_key", endpoints=endpoint_cfg)
```
See [`test_live.py`](https://github.com/limx0/betfair_parser/blob/main/tests/integration/test_live.py)
for more API call examples.
## Releasing
Releases are published automatically when a tag is pushed to GitHub.
```bash
# Set next version number
export RELEASE=x.x.x
# Create tags
git commit --allow-empty -m "Release $RELEASE"
git tag -a $RELEASE -m "Version $RELEASE"
# Push
git push --tags
git push
```
Raw data
{
"_id": null,
"home_page": "https://github.com/limx0/betfair_parser",
"name": "betfair-parser",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "parser, betfair, api, json, streaming",
"author": "Bradley McElroy",
"author_email": "bradley.mcelroy@live.com",
"download_url": "https://files.pythonhosted.org/packages/eb/8f/d4bd8ba15b58a179d6c3e74274831ed6b7d9f8eb0b5997daf319f28c961b/betfair_parser-0.14.1.tar.gz",
"platform": null,
"description": "\n\n[](https://github.com/limx0/betfair_parser/actions)\n[](https://pypi.org/project/betfair_parser/)\n\n\n[](https://github.com/psf/black)\n\n# betfair_parser\n\nA simple and fast betfair parser. Why you might like this library:\n\n- Complete: All betfair (non-vendor) client API included\n- Conventions: The API strictly follows pythonic naming conventions\n- Consistency: All data is type checked, API requests as well as responses\n- Comfort: All betfair enums and type definitions are included, to support IDE syntax completion\n- Clear errors: API errors don't just throw cryptic codes, but contain documentation about that error\n- Compatible: Use it with any HTTP library you like, including async libraries\n- Cheetah fast: Thanks to the magic of [msgspec](https://github.com/jcrist/msgspec), megabytes of input\nparse in milliseconds\n\n\n## Usage\n\n`betfair_parser` is built out of API building blocks, that can be used with any HTTP client\nyou like. All API operations provide `.headers()`, `.body()` and a `.parse_response()` method.\n\nThe [`client`](https://github.com/limx0/betfair_parser/blob/main/betfair_parser/client.py) module\ncontains a sample, minimalistic client implementation. It may be used as is with any `requests`-compatible\nHTTP client or serve as an example, how to integrate `betfair_parser` with other HTTP clients.\n\n```python\nimport requests\nfrom betfair_parser import client\nfrom betfair_parser.spec import accounts, betting\n\nsession = requests.Session() # or anything similar like httpx.Client()\nclient.login(session, \"username\", \"password\", \"app_key\")\nclient.request(session, accounts.GetAccountFunds.with_params())\n# AccountFundsResponse(available_to_bet_balance=10000.0, exposure=0.0,\n# retained_commission=0.0, exposure_limit=-10000.0, discount_rate=0.0,\n# points_balance=10, wallet=<Wallet.UK: 'UK'>)\n\n# Request with an invalid wallet parameter:\nclient.request(session, accounts.GetAccountFunds.with_params(wallet=\"AUS\"))\n# >>> AccountAPINGException: INVALID_PARAMETERS: Problem parsing the parameters,\n# or a mandatory parameter was not found\n\nclient.request(session, betting.ListCurrentOrders.with_params())\n# CurrentOrderSummaryReport(current_orders=[], more_available=False)\n\n# Support for other countries\nfrom betfair_parser.endpoints import endpoint\nendpoint_cfg = endpoint(\"ITA\") # alpha-3 code\nclient.login(session, \"username\", \"password\", \"app_key\", endpoints=endpoint_cfg)\n```\n\nSee [`test_live.py`](https://github.com/limx0/betfair_parser/blob/main/tests/integration/test_live.py)\nfor more API call examples.\n\n\n## Releasing\n\nReleases are published automatically when a tag is pushed to GitHub.\n\n```bash\n# Set next version number\nexport RELEASE=x.x.x\n\n# Create tags\ngit commit --allow-empty -m \"Release $RELEASE\"\ngit tag -a $RELEASE -m \"Version $RELEASE\"\n\n# Push\ngit push --tags\ngit push\n```\n\n",
"bugtrack_url": null,
"license": "Copyright 2023, betfair_parser developers Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "A betfair parser",
"version": "0.14.1",
"project_urls": {
"Bug Tracker": "https://github.com/limx0/betfair_parser/issues",
"Documentation": "https://limx0.github.io/betfair_parser/",
"Homepage": "https://github.com/limx0/betfair_parser"
},
"split_keywords": [
"parser",
" betfair",
" api",
" json",
" streaming"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ff155679a66525d0bf7c7a3bb4a53630caebf1fb0c801e3921b312309b8cbe64",
"md5": "583891a158b7585ed671789542767bba",
"sha256": "3e0a130e5b22cc0e2956abfbc9872037e9114aeb2cef0e2345bc2871a23b92eb"
},
"downloads": -1,
"filename": "betfair_parser-0.14.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "583891a158b7585ed671789542767bba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 66286,
"upload_time": "2025-01-11T06:42:25",
"upload_time_iso_8601": "2025-01-11T06:42:25.627111Z",
"url": "https://files.pythonhosted.org/packages/ff/15/5679a66525d0bf7c7a3bb4a53630caebf1fb0c801e3921b312309b8cbe64/betfair_parser-0.14.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb8fd4bd8ba15b58a179d6c3e74274831ed6b7d9f8eb0b5997daf319f28c961b",
"md5": "92e22d09de923d9493d953ac9cff4562",
"sha256": "55313435bee59d041c9c64c8927759e252484b87a3a54162509e0f44c177dabc"
},
"downloads": -1,
"filename": "betfair_parser-0.14.1.tar.gz",
"has_sig": false,
"md5_digest": "92e22d09de923d9493d953ac9cff4562",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 54611,
"upload_time": "2025-01-11T06:42:27",
"upload_time_iso_8601": "2025-01-11T06:42:27.565220Z",
"url": "https://files.pythonhosted.org/packages/eb/8f/d4bd8ba15b58a179d6c3e74274831ed6b7d9f8eb0b5997daf319f28c961b/betfair_parser-0.14.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-11 06:42:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "limx0",
"github_project": "betfair_parser",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "betfair-parser"
}
