<h1 align="center">smartbetsAPI</h1>
<p align="center">
<a href="https://github.com/Simatwa/smartbetsAPI"><img alt="Github" src="https://img.shields.io/static/v1?logo=github&color=blueviolet&label=Test&message=Passing"/></a> <a href="LICENSE"><img alt="License" src="https://img.shields.io/static/v1?logo=GPL&color=Blue&message=GPL-v3&label=License"/></a> <a href="https://pypi.org/project/smartbetsAPI"><img alt="PyPi" src="https://img.shields.io/pypi/v/smartbetsAPI?color=green"/></a> <a href="https://github.com/psf/black"><img alt="Black" src="https://img.shields.io/static/v1?logo=Black&label=Code-style&message=Black"/></a> <a href="#"><img alt="Accuracy" src="https://img.shields.io/static/v1?logo=accuracy&label=Accuracy&message=55%&color=yellow"/></a> <a href="#"><img alt="Passing" src="https://img.shields.io/static/v1?logo=Docs&label=Docs&message=Passing&color=green"/></a> <a href="#"><img alt="coverage" src="https://img.shields.io/static/v1?logo=Coverage&label=Coverage&message=100%&color=yellowgreen"/></a> <a href="#" alt="progress"><img alt="Progress" src="https://img.shields.io/static/v1?logo=Progress&label=Progress&message=95%&color=green"/></a> <a href="https://pepy.tech/project/smartbetsapi"><img src="https://static.pepy.tech/personalized-badge/smartbetsapi?period=total&units=international_system&left_color=grey&left_text=Downloads" alt="Downloads"></a></p><br>
> "Punter's choice"
Worldwide soccer-matches predictor with Fast-API and a package for integrating the scripts in your own [Python](https://python.org) code.
## Features
- REST-API
- Script integration (package)
- Non-ML
## Installation and usage
### Installation
*Python 3.9+* is required for this script to be fruitful to you.
- Installing through pip is always the most preferred way:
```sh
pip install smartbetsAPI
```
- For those who like enjoying the **latest** releases from [Github](https://github.com) like [me](https://github.com/Simatwa), rather than waiting for the next release:
```sh
pip install git+https://github.com/Simatwa/smartbetsAPI.git
```
- The hard-core guys with _trust issues_ are very much sorted this way:
```sh
git clone https://github.com/Simatwa/smartbetsAPI.git
cd smartbetsAPI
bash install.sh
#or
sudo bash install.sh
```
### Usage
1. Terminal
Running `$ smartbetsAPI <token/password>` will fire up the FastAPI server with the following default configurations.
<table align="center">
<thead>
<tr><th>Command </th><th>Default </th></tr>
</thead>
<tbody>
<tr><td>Port </td><td>8000 </td></tr>
<tr><td>Username </td><td>API</td></tr>
<tr><td>Filename </td><td>None </td></tr>
<tr><td>level (Logging)</td><td>20 </td></tr>
<tr><td>host </td><td>False </td></tr>
<tr><td>debug </td><td>False </td></tr>
<tr><td>no-net </td><td>False </td></tr>
<tr><td>log </td><td>False </td></tr>
<tr><td>colorize </td><td>False </td></tr>
<tr><td>gui (Termux) </td><td>False </td></tr>
</tbody>
</table>
- For instance :
```sh
$ smartbetsAPI mypass9876
```
> [!TIP]
> `Docs` will be available at : http://localhost:8000/v1/docs
> `Redoc` will be available at : http://localhost:8000/v1/redoc
Here is an example of a [simple program](examples/bet_at_rest_api_level.py) that makes prediction using the REST API.
> [!Note]
> Reinstall with `sudo` privileges if `smartbetsAPI` command can't be found.
> Example predicting using REST API
```py
from smartbets_API import predictor
predict = predictor('http://localhost:8080','password')
bets=predict.get_predictions('Arsenal','Manchester')
print(bets)
#Output
#(True, {'choice': 55.56, 'g': 14.0, 'gg': 80.0, 'ov15': 80.0, 'ov25': 65.0, 'ov35': 55.0, 'pick': 'ov15', 'result': '1'})
```
* For more information you can run `smartbetsAPI -h`
2. Importing Package
Module `predictor` provides two ways of interacting with it at the programming level, based on the `data-type` in which the teams have been packed and parsed to it:
* Using `predictorL` object which accepts *teams* (**List** data-type).
> For [example](examples/predict_using_list.py):
```py
#!/usr/bin/env python3
from smartbets_API.predictor import predictor
teams = [
"Napoli", # Home team (index [0])
"AC Milan", # Away team (index [1])
]
# Instantiating predictor
predict = predictor()
# Using predictorL object to handle teams (List data-type)
predictions = predict.predictorL(teams)
# Display info
print(predictions)
#Output
#{'g': 8.0, 'gg': 65.0, 'ov15': 70.0, 'ov25': 40.0, 'ov35': 30.0, 'choice': 60.0, 'result': '2', 'pick': 'ov15'}
```
* Using `predictorD` object which takes *teams* (**Dictionary** data-type):
> For [example](examples/predict_using_dict.py):
```py
#!/usr/bin/env python3
from smartbets_API.predictor import predictor
teams = {
1: "Manchester City", # 1 for home-team
2: "Liverpool", # 2 for away-team
}
# Instantiating predictor
predict = predictor()
# Using predictorD object to handle teams (Dictionary data-type)
predictions = predict.predictorD(teams)
# Display info
print(predictions)
#Output
#{'g': 8.0, 'gg': 65.0, 'ov15': 60.0, 'ov25': 45.0, 'ov35': 30.0, 'choice': 56.16, 'result': '1', 'pick': 'gg'}
```
- The output initials are explained in the table below.
<table>
<thead>
<tr><th>Parameter </th><th>Function </th></tr>
</thead>
<tbody>
<tr><td>g </td><td>Goal-average of the two teams </td></tr>
<tr><td>gg </td><td>Probability of both teams to score </td></tr>
<tr><td>ov15 </td><td>Probability of having more than 2 goals </td></tr>
<tr><td>ov25 </td><td>Probability of having more than 3 goals </td></tr>
<tr><td>ov35 </td><td>Probability of having more than 4 goals </td></tr>
<tr><td>choice </td><td>Probability of the specified 'result' to occur </td></tr>
<tr><td>result </td><td>The most suitable outcome from [1,1x,x,2x,2] </td></tr>
<tr><td>pick </td><td>The most suitable outcome from [1,1x,x,2x,2,gg,ov15,ov25,ov35]</td></tr>
</tbody>
</table>
> **Note**
- Probabilities are in percentange (%)
#### Further info
The `predictor` _class_ accepts multiple parameters that includes :
<table>
<thead>
<tr><th>Parameter </th><th>Function </th><th>Default </th></tr>
</thead>
<tbody>
<tr><td>include_position</td><td>Include team's league ranking in making predictions </td><td>False </td></tr>
<tr><td>log </td><td>Log at api default log's path </td><td>False </td></tr>
<tr><td>level </td><td>Logging level </td><td>0 </td></tr>
<tr><td>filename </td><td>Log to the filename specified </td><td>None </td></tr>
<tr><td>color </td><td>Colorize the logs </td><td>False </td></tr>
<tr><td>gui </td><td>Run with some Graphical interface notifications (Termux)</td><td>False </td></tr>
<tr><td>api </td><td>Run with api-server's configurations </td><td>False </td></tr>
</tbody>
</table>
The two predictor's object (`predictorD`, `predictorL`) accepts two parameters i.e.
* **teams** - Required
* **net** - Source of team's data - Default `True` (Online)
## Source of data
Team performances are sourced from [Soccerway](https://int.soccerway.com) after retrieving the *uri* from [Google](https://www.google.com).
> **Warning** Copyright related issues are liable to the user of this script!
## Disclaimer
This project aims to help *punters* and *bookmarkers* to make informed and well researched soccer-predictions. Nevertheless, it is important to specify that 100% accuracy does not exist and smartbetsAPI can't guarantee the accuracy of the predictions. It is therefore your responsibility to trust the information generated by smartbetsAPI after evaluating its reliability. As the [creator](https://github.com/Simatwa), I **CANNOT** be held responsible for any loss of capital that may occur during the use of this program.
## Contributing and Support
### Contributing
Contributions are always welcome! <br>
Please take a look at the [Contribution guidelines](CONTRIBUTING.md). <br>
Feel free to open an [Issue](https://github.com/Simatwa/smartbetsAPI/issues) or to [Fork](https://github.com/Simatwa/smartbetsAPI/fork) this repo.
### ToDo
- [ ] Upgrade to Machine learning
- [ ] Improve algorithim's accuracy
- [ ] General code improvements
- [ ] Fix bugs
### Support
Consider donating to this project if you find it useful:
<p align="center">
<a href="https://www.paypal.com/donate/?hosted_button_id=KLNYKSGUXY8R2"><img src="https://img.shields.io/static/v1?logo=paypal&message=Donate&color=blueviolet&label=Paypal"/></a>
</p>
## Credits
- [x] [Soccerway](https://int.soccerway.com)
- [x] [Google](https://www.google.com)
- [x] [Python.org](https://python.org)
## Special Thanks
* [x] [victhepythonista](https://github.com/victhepythonista)
* [x] YOU.
Raw data
{
"_id": null,
"home_page": "https://github.com/Simatwa/smartbetsAPI",
"name": "smartbetsAPI",
"maintainer": "Smartwa Caleb",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "smartwacaleb@gmail.com",
"keywords": "Football, Predictions, Betting API, Soccer predictions, Football Predictions",
"author": "Smartwa Caleb",
"author_email": "smartwacaleb@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2a/5b/a9f8df853895dc0bd0abe64c8a921b75335d35d37fcf44ed628c82ec88d8/smartbetsAPI-1.2.7.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">smartbetsAPI</h1>\n\n<p align=\"center\">\n\n <a href=\"https://github.com/Simatwa/smartbetsAPI\"><img alt=\"Github\" src=\"https://img.shields.io/static/v1?logo=github&color=blueviolet&label=Test&message=Passing\"/></a> <a href=\"LICENSE\"><img alt=\"License\" src=\"https://img.shields.io/static/v1?logo=GPL&color=Blue&message=GPL-v3&label=License\"/></a> <a href=\"https://pypi.org/project/smartbetsAPI\"><img alt=\"PyPi\" src=\"https://img.shields.io/pypi/v/smartbetsAPI?color=green\"/></a> <a href=\"https://github.com/psf/black\"><img alt=\"Black\" src=\"https://img.shields.io/static/v1?logo=Black&label=Code-style&message=Black\"/></a> <a href=\"#\"><img alt=\"Accuracy\" src=\"https://img.shields.io/static/v1?logo=accuracy&label=Accuracy&message=55%&color=yellow\"/></a> <a href=\"#\"><img alt=\"Passing\" src=\"https://img.shields.io/static/v1?logo=Docs&label=Docs&message=Passing&color=green\"/></a> <a href=\"#\"><img alt=\"coverage\" src=\"https://img.shields.io/static/v1?logo=Coverage&label=Coverage&message=100%&color=yellowgreen\"/></a> <a href=\"#\" alt=\"progress\"><img alt=\"Progress\" src=\"https://img.shields.io/static/v1?logo=Progress&label=Progress&message=95%&color=green\"/></a> <a href=\"https://pepy.tech/project/smartbetsapi\"><img src=\"https://static.pepy.tech/personalized-badge/smartbetsapi?period=total&units=international_system&left_color=grey&left_text=Downloads\" alt=\"Downloads\"></a></p><br>\n\n \n\n > \"Punter's choice\" \n\n\n\n Worldwide soccer-matches predictor with Fast-API and a package for integrating the scripts in your own [Python](https://python.org) code.\n\n\n\n ## Features\n\n\n\n - REST-API\n\n - Script integration (package)\n\n - Non-ML\n\n\n\n ## Installation and usage\n\n\n\n ### Installation\n\n\n\n*Python 3.9+* is required for this script to be fruitful to you. \n\n- Installing through pip is always the most preferred way:\n\n\n\n ```sh\n\n pip install smartbetsAPI\n\n \n\n ```\n\n\n\n - For those who like enjoying the **latest** releases from [Github](https://github.com) like [me](https://github.com/Simatwa), rather than waiting for the next release:\n\n\n\n ```sh\n\n pip install git+https://github.com/Simatwa/smartbetsAPI.git\n\n\n\n ```\n\n\n\n- The hard-core guys with _trust issues_ are very much sorted this way:\n\n\n\n ```sh\n\n\n\n git clone https://github.com/Simatwa/smartbetsAPI.git\n\n\n\n cd smartbetsAPI\n\n\n\n bash install.sh \n\n\n\n #or\n\n\n\nsudo bash install.sh\n\n\n\n```\n\n\n\n### Usage\n\n\n\n1. Terminal\n\n\n\n Running `$ smartbetsAPI <token/password>` will fire up the FastAPI server with the following default configurations.\n\n\n\n<table align=\"center\"> \n\n<thead>\n\n<tr><th>Command </th><th>Default </th></tr>\n\n</thead>\n\n<tbody>\n\n<tr><td>Port </td><td>8000 </td></tr>\n\n<tr><td>Username </td><td>API</td></tr>\n\n<tr><td>Filename </td><td>None </td></tr>\n\n<tr><td>level (Logging)</td><td>20 </td></tr>\n\n<tr><td>host </td><td>False </td></tr>\n\n<tr><td>debug </td><td>False </td></tr>\n\n<tr><td>no-net </td><td>False </td></tr>\n\n<tr><td>log </td><td>False </td></tr>\n\n<tr><td>colorize </td><td>False </td></tr>\n\n<tr><td>gui (Termux) </td><td>False </td></tr>\n\n</tbody>\n\n</table>\n\n\n\n- For instance :\n\n\n\n```sh\n\n $ smartbetsAPI mypass9876\n\n\n\n```\n\n\n\n> [!TIP]\n\n> `Docs` will be available at : http://localhost:8000/v1/docs\n\n> `Redoc` will be available at : http://localhost:8000/v1/redoc\n\n\n\nHere is an example of a [simple program](examples/bet_at_rest_api_level.py) that makes prediction using the REST API.\n\n\n\n\n\n\n\n> [!Note]\n\n> Reinstall with `sudo` privileges if `smartbetsAPI` command can't be found.\n\n\n\n> Example predicting using REST API\n\n\n\n```py\n\nfrom smartbets_API import predictor\n\npredict = predictor('http://localhost:8080','password')\n\nbets=predict.get_predictions('Arsenal','Manchester')\n\nprint(bets)\n\n#Output\n\n#(True, {'choice': 55.56, 'g': 14.0, 'gg': 80.0, 'ov15': 80.0, 'ov25': 65.0, 'ov35': 55.0, 'pick': 'ov15', 'result': '1'})\n\n```\n\n\n\n\n\n* For more information you can run `smartbetsAPI -h` \n\n\n\n\n\n2. Importing Package\n\n\n\nModule `predictor` provides two ways of interacting with it at the programming level, based on the `data-type` in which the teams have been packed and parsed to it:\n\n\n\n* Using `predictorL` object which accepts *teams* (**List** data-type).\n\n> For [example](examples/predict_using_list.py):\n\n\n\n```py\n\n#!/usr/bin/env python3\n\nfrom smartbets_API.predictor import predictor\n\n\n\nteams = [\n\n \"Napoli\", # Home team (index [0])\n\n \"AC Milan\", # Away team (index [1])\n\n]\n\n# Instantiating predictor\n\npredict = predictor()\n\n\n\n# Using predictorL object to handle teams (List data-type)\n\npredictions = predict.predictorL(teams)\n\n\n\n# Display info\n\nprint(predictions)\n\n\n\n#Output\n\n#{'g': 8.0, 'gg': 65.0, 'ov15': 70.0, 'ov25': 40.0, 'ov35': 30.0, 'choice': 60.0, 'result': '2', 'pick': 'ov15'}\n\n\n\n```\n\n\n\n* Using `predictorD` object which takes *teams* (**Dictionary** data-type):\n\n> For [example](examples/predict_using_dict.py):\n\n\n\n```py\n\n#!/usr/bin/env python3\n\nfrom smartbets_API.predictor import predictor\n\n\n\nteams = {\n\n 1: \"Manchester City\", # 1 for home-team\n\n 2: \"Liverpool\", # 2 for away-team\n\n}\n\n\n\n# Instantiating predictor\n\npredict = predictor()\n\n\n\n# Using predictorD object to handle teams (Dictionary data-type)\n\npredictions = predict.predictorD(teams)\n\n\n\n# Display info\n\nprint(predictions)\n\n\n\n#Output\n\n#{'g': 8.0, 'gg': 65.0, 'ov15': 60.0, 'ov25': 45.0, 'ov35': 30.0, 'choice': 56.16, 'result': '1', 'pick': 'gg'}\n\n\n\n```\n\n\n\n- The output initials are explained in the table below.\n\n\n\n<table>\n\n<thead>\n\n<tr><th>Parameter </th><th>Function </th></tr>\n\n</thead>\n\n<tbody>\n\n<tr><td>g </td><td>Goal-average of the two teams </td></tr>\n\n<tr><td>gg </td><td>Probability of both teams to score </td></tr>\n\n<tr><td>ov15 </td><td>Probability of having more than 2 goals </td></tr>\n\n<tr><td>ov25 </td><td>Probability of having more than 3 goals </td></tr>\n\n<tr><td>ov35 </td><td>Probability of having more than 4 goals </td></tr>\n\n<tr><td>choice </td><td>Probability of the specified 'result' to occur </td></tr>\n\n<tr><td>result </td><td>The most suitable outcome from [1,1x,x,2x,2] </td></tr>\n\n<tr><td>pick </td><td>The most suitable outcome from [1,1x,x,2x,2,gg,ov15,ov25,ov35]</td></tr>\n\n</tbody>\n\n</table>\n\n\n\n> **Note** \n\n - Probabilities are in percentange (%)\n\n\n\n#### Further info \n\n\n\nThe `predictor` _class_ accepts multiple parameters that includes :\n\n\n\n<table>\n\n<thead>\n\n<tr><th>Parameter </th><th>Function </th><th>Default </th></tr>\n\n</thead>\n\n<tbody>\n\n<tr><td>include_position</td><td>Include team's league ranking in making predictions </td><td>False </td></tr>\n\n<tr><td>log </td><td>Log at api default log's path </td><td>False </td></tr>\n\n<tr><td>level </td><td>Logging level </td><td>0 </td></tr>\n\n<tr><td>filename </td><td>Log to the filename specified </td><td>None </td></tr>\n\n<tr><td>color </td><td>Colorize the logs </td><td>False </td></tr>\n\n<tr><td>gui </td><td>Run with some Graphical interface notifications (Termux)</td><td>False </td></tr>\n\n<tr><td>api </td><td>Run with api-server's configurations </td><td>False </td></tr>\n\n</tbody>\n\n</table>\n\n\n\nThe two predictor's object (`predictorD`, `predictorL`) accepts two parameters i.e.\n\n* **teams** - Required\n\n* **net** - Source of team's data - Default `True` (Online)\n\n\n\n## Source of data\n\n\n\nTeam performances are sourced from [Soccerway](https://int.soccerway.com) after retrieving the *uri* from [Google](https://www.google.com).\n\n\n\n> **Warning** Copyright related issues are liable to the user of this script!\n\n\n\n## Disclaimer\n\n\n\nThis project aims to help *punters* and *bookmarkers* to make informed and well researched soccer-predictions. Nevertheless, it is important to specify that 100% accuracy does not exist and smartbetsAPI can't guarantee the accuracy of the predictions. It is therefore your responsibility to trust the information generated by smartbetsAPI after evaluating its reliability. As the [creator](https://github.com/Simatwa), I **CANNOT** be held responsible for any loss of capital that may occur during the use of this program.\n\n\n\n## Contributing and Support\n\n\n\n### Contributing\n\n\n\nContributions are always welcome! <br>\n\nPlease take a look at the [Contribution guidelines](CONTRIBUTING.md). <br>\n\nFeel free to open an [Issue](https://github.com/Simatwa/smartbetsAPI/issues) or to [Fork](https://github.com/Simatwa/smartbetsAPI/fork) this repo.\n\n\n\n### ToDo\n\n\n\n- [ ] Upgrade to Machine learning\n\n- [ ] Improve algorithim's accuracy\n\n- [ ] General code improvements\n\n- [ ] Fix bugs\n\n\n\n### Support \n\n\n\nConsider donating to this project if you find it useful:\n\n<p align=\"center\">\n\n<a href=\"https://www.paypal.com/donate/?hosted_button_id=KLNYKSGUXY8R2\"><img src=\"https://img.shields.io/static/v1?logo=paypal&message=Donate&color=blueviolet&label=Paypal\"/></a>\n\n</p>\n\n\n\n## Credits\n\n\n\n- [x] [Soccerway](https://int.soccerway.com)\n\n- [x] [Google](https://www.google.com)\n\n- [x] [Python.org](https://python.org)\n\n\n\n## Special Thanks\n\n\n\n* [x] [victhepythonista](https://github.com/victhepythonista)\n\n* [x] YOU.\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "Simple football prediction API",
"version": "1.2.7",
"project_urls": {
"Bug Report": "https://github.com/Simatwa/smartbetsAPI/issues/new",
"Documentation": "https://github.com/Simatwa/smartbetsAPI/blob/main/README.md",
"Download": "https://github.com/Simatwa/smartbetsAPI/releases",
"Homepage": "https://github.com/Simatwa/smartbetsAPI",
"Issue Tracker": "https://github.com/Simatwa/smartbetsAPI/issues",
"Source Code": "https://github.com/Simatwa/smartbetsAPI"
},
"split_keywords": [
"football",
" predictions",
" betting api",
" soccer predictions",
" football predictions"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a5ba9f8df853895dc0bd0abe64c8a921b75335d35d37fcf44ed628c82ec88d8",
"md5": "7e8e9311d8c7c19d93e97748f98ce52f",
"sha256": "a9f2e0e2ea4549d9fa89d5c2919d930b521798b5467c2da688b3f106edf2e967"
},
"downloads": -1,
"filename": "smartbetsAPI-1.2.7.tar.gz",
"has_sig": false,
"md5_digest": "7e8e9311d8c7c19d93e97748f98ce52f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 34656,
"upload_time": "2024-04-12T04:39:03",
"upload_time_iso_8601": "2024-04-12T04:39:03.899485Z",
"url": "https://files.pythonhosted.org/packages/2a/5b/a9f8df853895dc0bd0abe64c8a921b75335d35d37fcf44ed628c82ec88d8/smartbetsAPI-1.2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 04:39:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Simatwa",
"github_project": "smartbetsAPI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "fastapi",
"specs": [
[
"==",
"0.110.1"
]
]
},
{
"name": "appdirs",
"specs": [
[
"==",
"1.4.4"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "bs4",
"specs": [
[
"==",
"0.0.1"
]
]
},
{
"name": "Faker",
"specs": [
[
"==",
"15.3.4"
]
]
}
],
"lcname": "smartbetsapi"
}
JSON
