nadeo-api


Namenadeo-api JSON
Version 0.5.1 PyPI version JSON
download
home_pageNone
SummaryAccess Nadeo's web services API and the public Trackmania API
upload_time2024-05-20 07:32:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseMIT License Copyright (c) 2024 Ezio416 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords nadeo api trackmania
VCS
bugtrack_url
requirements requests
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # nadeo-api

<!-- [![tests](https://github.com/ezio416/py416/actions/workflows/tests.yml/badge.svg)](https://github.com/ezio416/py-nadeo-api/actions) -->
[![docs](https://readthedocs.org/projects/nadeo-api/badge/?version=latest)](https://nadeo-api.readthedocs.io/en/latest/)
[![PyPI](https://badge.fury.io/py/nadeo-api.svg)](https://pypi.org/project/nadeo-api/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A library to assist with accessing Nadeo's web services API and the public Trackmania API (OAuth2).

The web services API has community-driven documentation [here](https://webservices.openplanet.dev/).\
The main section of this API (named "Core") has an up-to-date list of valid endpoints being kept [here](https://github.com/openplanet-nl/core-api-tracking).\
Most of these endpoints are not documented at all, but you may help supplement the documentation [here](https://github.com/openplanet-nl/nadeoapi-docs).

The public Trackmania API has official documentation [here](https://api.trackmania.com/doc).\
There is also community-driven documentation [here](https://webservices.openplanet.dev/oauth/reference) which should be a bit more useful.

Installing the package from PyPI:
```
python -m pip install nadeo-api
```

Using the package:
```py
import nadeo_api        # main module - functions not related to endpoints
import nadeo_api.auth   # authentication - required for any endpoint
import nadeo_api.core   # web services Core endpoints
import nadeo_api.live   # web services Live endpoints
import nadeo_api.meet   # web services Meet endpoints
import nadeo_api.oauth  # OAuth2 endpoints (public API)
import nadeo_api.util   # unnecessary - use the main module instead
```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nadeo-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "nadeo, api, trackmania",
    "author": null,
    "author_email": "Ezio416 <e@e416.dev>",
    "download_url": "https://files.pythonhosted.org/packages/a1/ff/0a6135d95446232960bc627e584cafdb2d59b12725bc4bed76bdaf0bf321/nadeo_api-0.5.1.tar.gz",
    "platform": null,
    "description": "# nadeo-api\r\n\r\n<!-- [![tests](https://github.com/ezio416/py416/actions/workflows/tests.yml/badge.svg)](https://github.com/ezio416/py-nadeo-api/actions) -->\r\n[![docs](https://readthedocs.org/projects/nadeo-api/badge/?version=latest)](https://nadeo-api.readthedocs.io/en/latest/)\r\n[![PyPI](https://badge.fury.io/py/nadeo-api.svg)](https://pypi.org/project/nadeo-api/)\r\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\r\n\r\nA library to assist with accessing Nadeo's web services API and the public Trackmania API (OAuth2).\r\n\r\nThe web services API has community-driven documentation [here](https://webservices.openplanet.dev/).\\\r\nThe main section of this API (named \"Core\") has an up-to-date list of valid endpoints being kept [here](https://github.com/openplanet-nl/core-api-tracking).\\\r\nMost of these endpoints are not documented at all, but you may help supplement the documentation [here](https://github.com/openplanet-nl/nadeoapi-docs).\r\n\r\nThe public Trackmania API has official documentation [here](https://api.trackmania.com/doc).\\\r\nThere is also community-driven documentation [here](https://webservices.openplanet.dev/oauth/reference) which should be a bit more useful.\r\n\r\nInstalling the package from PyPI:\r\n```\r\npython -m pip install nadeo-api\r\n```\r\n\r\nUsing the package:\r\n```py\r\nimport nadeo_api        # main module - functions not related to endpoints\r\nimport nadeo_api.auth   # authentication - required for any endpoint\r\nimport nadeo_api.core   # web services Core endpoints\r\nimport nadeo_api.live   # web services Live endpoints\r\nimport nadeo_api.meet   # web services Meet endpoints\r\nimport nadeo_api.oauth  # OAuth2 endpoints (public API)\r\nimport nadeo_api.util   # unnecessary - use the main module instead\r\n```\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Ezio416  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Access Nadeo's web services API and the public Trackmania API",
    "version": "0.5.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/ezio416/py-nadeo-api/issues",
        "Documentation": "https://nadeo-api.readthedocs.io/en/latest/",
        "Repository": "https://github.com/ezio416/py-nadeo-api"
    },
    "split_keywords": [
        "nadeo",
        " api",
        " trackmania"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "11472af0abd7083968298ed2d6ac7b1c52bd47846357c4add5b7a9efaf011f34",
                "md5": "1bbe327e36e084ceeccc4079d41b0897",
                "sha256": "c9e12fa87809b097ff68dfa2388db21925937b9d26655812b2c352b6c0b90a1f"
            },
            "downloads": -1,
            "filename": "nadeo_api-0.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1bbe327e36e084ceeccc4079d41b0897",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 11651,
            "upload_time": "2024-05-20T07:32:38",
            "upload_time_iso_8601": "2024-05-20T07:32:38.421910Z",
            "url": "https://files.pythonhosted.org/packages/11/47/2af0abd7083968298ed2d6ac7b1c52bd47846357c4add5b7a9efaf011f34/nadeo_api-0.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a1ff0a6135d95446232960bc627e584cafdb2d59b12725bc4bed76bdaf0bf321",
                "md5": "67dc5e0a6840a0b84b61b7a14ff35d9c",
                "sha256": "333d03ddb09183887853129f889ee8201b2023047b2cd8c3987d00903538a9b9"
            },
            "downloads": -1,
            "filename": "nadeo_api-0.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "67dc5e0a6840a0b84b61b7a14ff35d9c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 9846,
            "upload_time": "2024-05-20T07:32:39",
            "upload_time_iso_8601": "2024-05-20T07:32:39.369813Z",
            "url": "https://files.pythonhosted.org/packages/a1/ff/0a6135d95446232960bc627e584cafdb2d59b12725bc4bed76bdaf0bf321/nadeo_api-0.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-20 07:32:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ezio416",
    "github_project": "py-nadeo-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "requests",
            "specs": [
                [
                    ">=",
                    "2.31.0"
                ]
            ]
        }
    ],
    "lcname": "nadeo-api"
}
None
Elapsed time: 0.28854s