nadeo-api


Namenadeo-api JSON
Version 0.7.0 PyPI version JSON
download
home_pageNone
SummaryAccess Nadeo's web services API and the public Trackmania API
upload_time2025-08-05 20:24:33
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseNone
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 - various things
import nadeo_api.auth    # authentication - required for any endpoint
import nadeo_api.config  # configuration options
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
```

Configuration options in `nadeo_api.config`:
```py
nadeo_api.config.debug_logging = True            # enable debug logging
nadeo_api.config.wait_between_requests_ms = 500  # change self rate limiting
```

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/05/62/2279f5eca22c479c979c5220a50eb942aca3491315ab78ddf3b2c4dd2b73/nadeo_api-0.7.0.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 - various things\r\nimport nadeo_api.auth    # authentication - required for any endpoint\r\nimport nadeo_api.config  # configuration options\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\r\nConfiguration options in `nadeo_api.config`:\r\n```py\r\nnadeo_api.config.debug_logging = True            # enable debug logging\r\nnadeo_api.config.wait_between_requests_ms = 500  # change self rate limiting\r\n```\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Access Nadeo's web services API and the public Trackmania API",
    "version": "0.7.0",
    "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": null,
            "digests": {
                "blake2b_256": "efabb218093022c1f1ec679a1afc58c1ac227251941ef9fb05d730cfa548ba61",
                "md5": "6997e5da0824f4cb774c1332d85acf21",
                "sha256": "83349c98c670b1a6211fdeae8de08475e99246c9e5c8a7176f6072e651c041be"
            },
            "downloads": -1,
            "filename": "nadeo_api-0.7.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6997e5da0824f4cb774c1332d85acf21",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 14835,
            "upload_time": "2025-08-05T20:24:32",
            "upload_time_iso_8601": "2025-08-05T20:24:32.323200Z",
            "url": "https://files.pythonhosted.org/packages/ef/ab/b218093022c1f1ec679a1afc58c1ac227251941ef9fb05d730cfa548ba61/nadeo_api-0.7.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "05622279f5eca22c479c979c5220a50eb942aca3491315ab78ddf3b2c4dd2b73",
                "md5": "fe689fcafaf514d6c19247b1b2ff07e3",
                "sha256": "345f96440ad270ad6259d44316ed5614b70a3780eaa3b49a290ad70ded0334b6"
            },
            "downloads": -1,
            "filename": "nadeo_api-0.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fe689fcafaf514d6c19247b1b2ff07e3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 12014,
            "upload_time": "2025-08-05T20:24:33",
            "upload_time_iso_8601": "2025-08-05T20:24:33.479605Z",
            "url": "https://files.pythonhosted.org/packages/05/62/2279f5eca22c479c979c5220a50eb942aca3491315ab78ddf3b2c4dd2b73/nadeo_api-0.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-05 20:24:33",
    "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: 1.61832s