TruckersMP


NameTruckersMP JSON
Version 1.0.1 PyPI version JSON
download
home_pagehttps://github.com/Belyashik2K/TruckersMP
SummaryFully async python wrapper for TruckersMP API
upload_time2023-10-10 18:00:12
maintainer
docs_urlNone
authorBelyashik2K
requires_python
licenseApache License, Version 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![snapedit_1696958911490](https://github.com/Belyashik2K/TruckersMP/assets/126521808/49b0190c-c741-4f36-bcc7-aed9d2e1d187)
# TruckersMP
> Fully async python wrapper for [TruckersMP API](https://truckersmp.com/developers/api)

## Installing

    pip install TruckersMP

## Features
* Fully async methods
* All methods return Pydantic model as result for easier interaction with data
* Full exception handling

## Usage
```python
from TruckersMP import TruckersMPClient

async def main():

    client = TruckersMPClient()

    # Get info about player
    player = await client.get_player(1)
    print("Player info")
    print("Player name >>>", player.name)
    print("Player ID >>>", player.id)
    print("Player join date >>>", player.joinDate)
    print('Is player in staff >>>', player.permissions.isStaff)
    print('Is player banned >>>', player.banned)

    print("-----------------------------------")

    # Get info about VTC
    vtc = await client.get_vtc(1)
    print("VTC info")
    print("VTC name >>>", vtc.name)
    print("VTC ID >>>", vtc.id)
    print("VTC tag >>>", vtc.tag)
    print("VTC owner >>>", vtc.owner_username)
    print("VTC members >>>", vtc.members_count)

    # And more...

if __name__ == '__main__':
    import asyncio
    asyncio.run(main())
```

## Docs
> Go to https://truckersmp.com/developers/api for more information about API

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Belyashik2K/TruckersMP",
    "name": "TruckersMP",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Belyashik2K",
    "author_email": "lovelybelyashik@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/90/5a/9c50b7724ecda1afe2995dcb34b67f670aebc6862ca11da164249776c528/TruckersMP-1.0.1.tar.gz",
    "platform": null,
    "description": "![snapedit_1696958911490](https://github.com/Belyashik2K/TruckersMP/assets/126521808/49b0190c-c741-4f36-bcc7-aed9d2e1d187)\r\n# TruckersMP\r\n> Fully async python wrapper for [TruckersMP API](https://truckersmp.com/developers/api)\r\n\r\n## Installing\r\n\r\n    pip install TruckersMP\r\n\r\n## Features\r\n* Fully async methods\r\n* All methods return Pydantic model as result for easier interaction with data\r\n* Full exception handling\r\n\r\n## Usage\r\n```python\r\nfrom TruckersMP import TruckersMPClient\r\n\r\nasync def main():\r\n\r\n    client = TruckersMPClient()\r\n\r\n    # Get info about player\r\n    player = await client.get_player(1)\r\n    print(\"Player info\")\r\n    print(\"Player name >>>\", player.name)\r\n    print(\"Player ID >>>\", player.id)\r\n    print(\"Player join date >>>\", player.joinDate)\r\n    print('Is player in staff >>>', player.permissions.isStaff)\r\n    print('Is player banned >>>', player.banned)\r\n\r\n    print(\"-----------------------------------\")\r\n\r\n    # Get info about VTC\r\n    vtc = await client.get_vtc(1)\r\n    print(\"VTC info\")\r\n    print(\"VTC name >>>\", vtc.name)\r\n    print(\"VTC ID >>>\", vtc.id)\r\n    print(\"VTC tag >>>\", vtc.tag)\r\n    print(\"VTC owner >>>\", vtc.owner_username)\r\n    print(\"VTC members >>>\", vtc.members_count)\r\n\r\n    # And more...\r\n\r\nif __name__ == '__main__':\r\n    import asyncio\r\n    asyncio.run(main())\r\n```\r\n\r\n## Docs\r\n> Go to https://truckersmp.com/developers/api for more information about API\r\n",
    "bugtrack_url": null,
    "license": "Apache License, Version 2.0",
    "summary": "Fully async python wrapper for TruckersMP API",
    "version": "1.0.1",
    "project_urls": {
        "Homepage": "https://github.com/Belyashik2K/TruckersMP"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "905a9c50b7724ecda1afe2995dcb34b67f670aebc6862ca11da164249776c528",
                "md5": "55d63f1ac59dfb041939fbd8e27709a5",
                "sha256": "b60b57f0e695488db19e6ec8807ea32e6af741769a8c0d1c6e80cd5e3a37022a"
            },
            "downloads": -1,
            "filename": "TruckersMP-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "55d63f1ac59dfb041939fbd8e27709a5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7343,
            "upload_time": "2023-10-10T18:00:12",
            "upload_time_iso_8601": "2023-10-10T18:00:12.695466Z",
            "url": "https://files.pythonhosted.org/packages/90/5a/9c50b7724ecda1afe2995dcb34b67f670aebc6862ca11da164249776c528/TruckersMP-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-10 18:00:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Belyashik2K",
    "github_project": "TruckersMP",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "truckersmp"
}
        
Elapsed time: 0.24559s