# Battlemetrics API Wrapper
This repository allows users to quickly and easily pull data from the Battlemetrics API. Removing a lot of the guesswork when reading the API.
## Alternatives
### Javascript
For the javascript equivalent, visit this repository: https://github.com/cubiquitous/battlemetrics-js
# Disclaimer
Please note that I am an individual member of the community and not affiliated with Battlemetrics. The resources provided here are developed to facilitate the usage of the Battlemetrics API but come with no official endorsement or sponsorship from Battlemetrics.
It's important to understand that any actions you take using these resources are solely your responsibility. I am not liable for any damage or consequences that may occur to your server or account. Please exercise caution and ensure that you follow best practices when using the API.
## Getting Started
To begin using the Battlemetrics API, make sure you have RCON access and an API token. If you don't have an API token yet, you can obtain one by visiting the [Battlemetrics developers page](https://www.battlemetrics.com/developers).
## Installation
1. Clone or Install this repo:
Clone this repository
```bash
git clone https://github.com/Gnomeslayer/battlemetrics.git
```
Pip install
```bash
pip install battlemetrics
```
2. Install the required dependencies
or you can do:
```bash
pip install -r requirements.txt
```
3. Import the `Battlemetrics` class into your project.
```bash
from battlemetrics import Battlemetrics
```
## Usage
Refer to example file for examples.
Here's an example of how to use the Battlemetrics API wrapper:
```bash
# Instantiate the API wrapper with your token
bmapi = battlemetrics("Your token here")
# Retrieve player information
player = asyncio.run(bmapi.player.search(12345))
# Print the player information
print(player)
```
Make sure to replace `"Your API token here"` with your actual API token obtained from the Battlemetrics developers page.
## Resources
For more details on the Battlemetrics API and its capabilities, refer to the official [Battlemetrics API](https://www.battlemetrics.com/developers/documentation).
## Contributing
If you find any issues or have suggestions for improvement, please feel free to submit a pull request or open an issue in the [issue tracker](https://github.com/Gnomeslayer/battlemetrics/issues). I welcome contributions from the community!
## Contact
You can contact me on Discord, simply add me: gnomeslayer
or, you can join the official [Battlemetrics discord](https://discord.gg/xWa3UNG4yh) and @gnomeslayer there.
## Suport
This repository will ALWAYS be free and hopefully regularly updated, but if you want to support me, you can do so [Here](https://ko-fi.com/gnomeslayer)
Raw data
{
"_id": null,
"home_page": null,
"name": "battlemetrics",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "battlemetrics, battlemetricsapi, api, gaming",
"author": null,
"author_email": "Gnomeslayer <declan.otten@live.com.au>",
"download_url": "https://files.pythonhosted.org/packages/ad/81/e7283bc7220ead5b5c2844830e8663a95b26283586e18fab135dcc87a0d3/battlemetrics-1.0.13.tar.gz",
"platform": null,
"description": "# Battlemetrics API Wrapper\r\n\r\nThis repository allows users to quickly and easily pull data from the Battlemetrics API. Removing a lot of the guesswork when reading the API.\r\n\r\n## Alternatives\r\n\r\n### Javascript\r\nFor the javascript equivalent, visit this repository: https://github.com/cubiquitous/battlemetrics-js\r\n\r\n# Disclaimer\r\nPlease note that I am an individual member of the community and not affiliated with Battlemetrics. The resources provided here are developed to facilitate the usage of the Battlemetrics API but come with no official endorsement or sponsorship from Battlemetrics.\r\n\r\nIt's important to understand that any actions you take using these resources are solely your responsibility. I am not liable for any damage or consequences that may occur to your server or account. Please exercise caution and ensure that you follow best practices when using the API.\r\n\r\n## Getting Started\r\n\r\nTo begin using the Battlemetrics API, make sure you have RCON access and an API token. If you don't have an API token yet, you can obtain one by visiting the [Battlemetrics developers page](https://www.battlemetrics.com/developers).\r\n\r\n## Installation\r\n\r\n1. Clone or Install this repo:\r\n\r\n Clone this repository\r\n ```bash\r\n git clone https://github.com/Gnomeslayer/battlemetrics.git\r\n ```\r\n Pip install\r\n ```bash\r\n pip install battlemetrics\r\n ```\r\n\r\n2. Install the required dependencies\r\n\r\n or you can do:\r\n ```bash\r\n pip install -r requirements.txt\r\n ```\r\n\r\n3. Import the `Battlemetrics` class into your project.\r\n ```bash\r\n from battlemetrics import Battlemetrics\r\n ```\r\n\r\n## Usage\r\nRefer to example file for examples.\r\nHere's an example of how to use the Battlemetrics API wrapper:\r\n```bash\r\n# Instantiate the API wrapper with your token\r\nbmapi = battlemetrics(\"Your token here\")\r\n\r\n# Retrieve player information\r\nplayer = asyncio.run(bmapi.player.search(12345))\r\n\r\n# Print the player information\r\nprint(player)\r\n```\r\nMake sure to replace `\"Your API token here\"` with your actual API token obtained from the Battlemetrics developers page.\r\n\r\n\r\n## Resources\r\nFor more details on the Battlemetrics API and its capabilities, refer to the official [Battlemetrics API](https://www.battlemetrics.com/developers/documentation).\r\n\r\n## Contributing\r\nIf you find any issues or have suggestions for improvement, please feel free to submit a pull request or open an issue in the [issue tracker](https://github.com/Gnomeslayer/battlemetrics/issues). I welcome contributions from the community!\r\n\r\n## Contact\r\nYou can contact me on Discord, simply add me: gnomeslayer\r\nor, you can join the official [Battlemetrics discord](https://discord.gg/xWa3UNG4yh) and @gnomeslayer there.\r\n\r\n\r\n## Suport\r\nThis repository will ALWAYS be free and hopefully regularly updated, but if you want to support me, you can do so [Here](https://ko-fi.com/gnomeslayer)\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Battlemetrics API wrapper.",
"version": "1.0.13",
"project_urls": {
"Homepage": "https://github.com/Gnomeslayer/battlemetrics"
},
"split_keywords": [
"battlemetrics",
" battlemetricsapi",
" api",
" gaming"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c37763f3eb7df88af6e7331cd605e4713e584d9c385e6631c1d9bf0b61112ce",
"md5": "3f9f12d9e55b592bac9590603ac9deac",
"sha256": "9b796d4de060e442aa584b3fc6c9ab4d9916bd3d6f1db97489168a8242468d1a"
},
"downloads": -1,
"filename": "battlemetrics-1.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f9f12d9e55b592bac9590603ac9deac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 27621,
"upload_time": "2024-08-21T10:40:49",
"upload_time_iso_8601": "2024-08-21T10:40:49.660253Z",
"url": "https://files.pythonhosted.org/packages/0c/37/763f3eb7df88af6e7331cd605e4713e584d9c385e6631c1d9bf0b61112ce/battlemetrics-1.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ad81e7283bc7220ead5b5c2844830e8663a95b26283586e18fab135dcc87a0d3",
"md5": "5449b9b897905d52c2c35646554884de",
"sha256": "a644c6a724874d5d1c6e5b5a3bc2feaf0a1f244963bf6bba21e8ff12a48af5a6"
},
"downloads": -1,
"filename": "battlemetrics-1.0.13.tar.gz",
"has_sig": false,
"md5_digest": "5449b9b897905d52c2c35646554884de",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 22348,
"upload_time": "2024-08-21T10:40:51",
"upload_time_iso_8601": "2024-08-21T10:40:51.753731Z",
"url": "https://files.pythonhosted.org/packages/ad/81/e7283bc7220ead5b5c2844830e8663a95b26283586e18fab135dcc87a0d3/battlemetrics-1.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 10:40:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Gnomeslayer",
"github_project": "battlemetrics",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "battlemetrics"
}
JSON
