nitrado

Name	nitrado JSON
Version	1.0.33 JSON
	download
home_page	https://github.com/mjlomeli/NitradoAPI
Summary	This application accesses the Nitrado API.
upload_time	2023-06-27 05:54:31
maintainer
docs_url	None
author	Mauricio
requires_python	>=3.9
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Nitrado SDK    ![Python](https://img.shields.io/badge/Python-3776AB.svg?style=for-the-badge&logo=Python&logoColor=white)

[![Testing](https://github.com/mjlomeli/NitradoAPI/actions/workflows/tests.yml/badge.svg)](#)


A Python based SDK for the [Nitrado RESTful API](https://doc.nitrado.net/) published at [PyPI](https://pypi.org/project/nitrado/).

<br />

# Installation
In your terminal install the nitrado package with pip.

```shell
pip install nitrado
```

<br />

# Overview

To have access to this application you must have an account created at [Nitrado](https://server.nitrado.net/)
and create an API key.

# [Wiki - Full documentation](https://github.com/mjlomeli/NitradoAPI/wiki)
### Table of contents
#### 1. [Generate API Key](https://github.com/mjlomeli/NitradoAPI/wiki/Generate-API-Key)
   > Shows how to get access to your API key.
#### 2. [Getting Started](https://github.com/mjlomeli/NitradoAPI/wiki/Getting-Started)
   > Shows how to log in to the client and use the basic code interface
#### 3. [Globals](https://github.com/mjlomeli/NitradoAPI/wiki/Globals)
   > Basic requests from Nitrado for health and maintenance checks.
#### 4. [Services](https://github.com/mjlomeli/NitradoAPI/wiki/Services)
   > Data provided outside of the game server. Like server status, user id, and auto extension plan.
#### 5. [GameServer](https://github.com/mjlomeli/NitradoAPI/wiki/GameServer)
   > Data directly related to the game server. This includes the player list, game settings, etc.
#### 6. [Games](https://github.com/mjlomeli/NitradoAPI/wiki/Games)
   > Custom game specific libraries.

<br />
<br />

# Examples


### [Globals](https://github.com/mjlomeli/NitradoAPI/wiki/Globals)
The basic maintanance tools from Nitrado API.

```python
from nitrado import Global

version = Global.version()
print(version)

'nitrapi-1201-wh2h4'
```
<br />

### [Services](https://github.com/mjlomeli/NitradoAPI/wiki/Services)
This example highlights how to get the service.

```python
from nitrado import Service

services = Service.all()
print(services)
```
```python
[
    <Service(id=1011111, status='active', type_human='Publicserver 10 slots', suspend_date='2023-05-07T01:21:11')>,
    <Service(id=1022222, status='active', type_human='Publicserver 20 slots', suspend_date='2023-07-07T02:11:01')>,
    <Service(id=1033333, status='active', type_human='Publicserver 30 slots', suspend_date='2023-09-07T06:51:41')>
]
``` 
<br />

### [GameServer](https://github.com/mjlomeli/NitradoAPI/wiki/GameServer)
This example highlights how to get the gameserver.

```python
from nitrado import GameServer

gameservers = GameServer.all()
print(gameservers)
```
```python
[
    <GameServer(service_id=11111111, location='US', slots=10, ip='1.2.3.4', game_human='ARK: Survival Evolved (Xbox One)')>,
    <GameServer(service_id=22222222, location='US', slots=70, ip='11.22.33.44', game_human='ARK: Survival Evolved (Xbox One)')>
]
```

<br />


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mjlomeli/NitradoAPI",
    "name": "nitrado",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "",
    "author": "Mauricio",
    "author_email": "dev.mauricio.lomeli@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/cb/57/f50692af3165d3dbf35c178c364fd1f3a31d567f30cba7838ae3c059d538/nitrado-1.0.33.tar.gz",
    "platform": "unix",
    "description": "# Nitrado SDK  &nbsp; ![Python](https://img.shields.io/badge/Python-3776AB.svg?style=for-the-badge&logo=Python&logoColor=white)\r\n\r\n[![Testing](https://github.com/mjlomeli/NitradoAPI/actions/workflows/tests.yml/badge.svg)](#)\r\n\r\n\r\nA Python based SDK for the [Nitrado RESTful API](https://doc.nitrado.net/) published at [PyPI](https://pypi.org/project/nitrado/).\r\n\r\n<br />\r\n\r\n# Installation\r\nIn your terminal install the nitrado package with pip.\r\n\r\n```shell\r\npip install nitrado\r\n```\r\n\r\n<br />\r\n\r\n# Overview\r\n\r\nTo have access to this application you must have an account created at [Nitrado](https://server.nitrado.net/)\r\nand create an API key.\r\n\r\n# [Wiki - Full documentation](https://github.com/mjlomeli/NitradoAPI/wiki)\r\n### Table of contents\r\n#### 1. [Generate API Key](https://github.com/mjlomeli/NitradoAPI/wiki/Generate-API-Key)\r\n   > Shows how to get access to your API key.\r\n#### 2. [Getting Started](https://github.com/mjlomeli/NitradoAPI/wiki/Getting-Started)\r\n   > Shows how to log in to the client and use the basic code interface\r\n#### 3. [Globals](https://github.com/mjlomeli/NitradoAPI/wiki/Globals)\r\n   > Basic requests from Nitrado for health and maintenance checks.\r\n#### 4. [Services](https://github.com/mjlomeli/NitradoAPI/wiki/Services)\r\n   > Data provided outside of the game server. Like server status, user id, and auto extension plan.\r\n#### 5. [GameServer](https://github.com/mjlomeli/NitradoAPI/wiki/GameServer)\r\n   > Data directly related to the game server. This includes the player list, game settings, etc.\r\n#### 6. [Games](https://github.com/mjlomeli/NitradoAPI/wiki/Games)\r\n   > Custom game specific libraries.\r\n\r\n<br />\r\n<br />\r\n\r\n# Examples\r\n\r\n\r\n### [Globals](https://github.com/mjlomeli/NitradoAPI/wiki/Globals)\r\nThe basic maintanance tools from Nitrado API.\r\n\r\n```python\r\nfrom nitrado import Global\r\n\r\nversion = Global.version()\r\nprint(version)\r\n\r\n'nitrapi-1201-wh2h4'\r\n```\r\n<br />\r\n\r\n### [Services](https://github.com/mjlomeli/NitradoAPI/wiki/Services)\r\nThis example highlights how to get the service.\r\n\r\n```python\r\nfrom nitrado import Service\r\n\r\nservices = Service.all()\r\nprint(services)\r\n```\r\n```python\r\n[\r\n    <Service(id=1011111, status='active', type_human='Publicserver 10 slots', suspend_date='2023-05-07T01:21:11')>,\r\n    <Service(id=1022222, status='active', type_human='Publicserver 20 slots', suspend_date='2023-07-07T02:11:01')>,\r\n    <Service(id=1033333, status='active', type_human='Publicserver 30 slots', suspend_date='2023-09-07T06:51:41')>\r\n]\r\n``` \r\n<br />\r\n\r\n### [GameServer](https://github.com/mjlomeli/NitradoAPI/wiki/GameServer)\r\nThis example highlights how to get the gameserver.\r\n\r\n```python\r\nfrom nitrado import GameServer\r\n\r\ngameservers = GameServer.all()\r\nprint(gameservers)\r\n```\r\n```python\r\n[\r\n    <GameServer(service_id=11111111, location='US', slots=10, ip='1.2.3.4', game_human='ARK: Survival Evolved (Xbox One)')>,\r\n    <GameServer(service_id=22222222, location='US', slots=70, ip='11.22.33.44', game_human='ARK: Survival Evolved (Xbox One)')>\r\n]\r\n```\r\n\r\n<br />\r\n\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "This application accesses the Nitrado API.",
    "version": "1.0.33",
    "project_urls": {
        "Bug Tracker": "https://github.com/mjlomeli/NitradoAPI/issues",
        "Homepage": "https://github.com/mjlomeli/NitradoAPI"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "07ae3ea2b494488c7b357f48e830d87061aeed11616750e864b314ee0d854950",
                "md5": "375319910e54bda573134f9bf0682260",
                "sha256": "330d607a5ecc19430a15cb67a309dddca730163dd7ecdedb51f4c285abc0ae05"
            },
            "downloads": -1,
            "filename": "nitrado-1.0.33-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "375319910e54bda573134f9bf0682260",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 37477,
            "upload_time": "2023-06-27T05:54:30",
            "upload_time_iso_8601": "2023-06-27T05:54:30.491750Z",
            "url": "https://files.pythonhosted.org/packages/07/ae/3ea2b494488c7b357f48e830d87061aeed11616750e864b314ee0d854950/nitrado-1.0.33-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cb57f50692af3165d3dbf35c178c364fd1f3a31d567f30cba7838ae3c059d538",
                "md5": "52bb7187a4eedc464f834abb454f54d2",
                "sha256": "8d987a5afd5c9a2846fd4a3d3fd639cf939a6404c2e381bd506f5b995230eecd"
            },
            "downloads": -1,
            "filename": "nitrado-1.0.33.tar.gz",
            "has_sig": false,
            "md5_digest": "52bb7187a4eedc464f834abb454f54d2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 33338,
            "upload_time": "2023-06-27T05:54:31",
            "upload_time_iso_8601": "2023-06-27T05:54:31.919601Z",
            "url": "https://files.pythonhosted.org/packages/cb/57/f50692af3165d3dbf35c178c364fd1f3a31d567f30cba7838ae3c059d538/nitrado-1.0.33.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-27 05:54:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mjlomeli",
    "github_project": "NitradoAPI",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "nitrado"
}