Welcome to Fantrax Documentation!
==========================================================
.. image:: https://img.shields.io/github/v/release/meisnate12/FantraxAPI?style=plastic
:target: https://github.com/meisnate12/FantraxAPI/releases
:alt: GitHub release (latest by date)
.. image:: https://img.shields.io/github/actions/workflow/status/meisnate12/FantraxAPI/tests.yml?branch=master&style=plastic
:target: https://github.com/meisnate12/FantraxAPI/actions/workflows/tests.yml
:alt: Build Testing
.. image:: https://img.shields.io/codecov/c/github/meisnate12/FantraxAPI?color=greenred&style=plastic
:target: https://codecov.io/gh/meisnate12/FantraxAPI
:alt: Build Coverage
.. image:: https://img.shields.io/github/commits-since/meisnate12/FantraxAPI/latest?style=plastic
:target: https://github.com/meisnate12/FantraxAPI/commits/master
:alt: GitHub commits since latest release (by date) for a branch
.. image:: https://img.shields.io/pypi/v/FantraxAPI?style=plastic
:target: https://pypi.org/project/FantraxAPI/
:alt: PyPI
.. image:: https://img.shields.io/pypi/dm/FantraxAPI.svg?style=plastic
:target: https://pypi.org/project/FantraxAPI/
:alt: Downloads
.. image:: https://img.shields.io/readthedocs/plex-meta-manager?color=%2300bc8c&style=plastic
:target: https://fantraxapi.metamanager.wiki/en/latest/
:alt: Wiki
.. image:: https://img.shields.io/discord/822460010649878528?color=%2300bc8c&label=Discord&style=plastic
:target: https://discord.gg/NfH6mGFuAB
:alt: Discord
.. image:: https://img.shields.io/reddit/subreddit-subscribers/PlexMetaManager?color=%2300bc8c&label=r%2FPlexMetaManager&style=plastic
:target: https://www.reddit.com/r/PlexMetaManager/
:alt: Reddit
.. image:: https://img.shields.io/github/sponsors/meisnate12?color=%238a2be2&style=plastic
:target: https://github.com/sponsors/meisnate12
:alt: GitHub Sponsors
.. image:: https://img.shields.io/badge/-Sponsor_or_Donate-blueviolet?style=plastic
:target: https://github.com/sponsors/meisnate12
:alt: Sponsor or Donate
Overview
----------------------------------------------------------
Unofficial Python bindings for the Fantrax API. The goal is to make interaction with the API as easy as possible while emulating the endpoints as much as possible
Installation & Documentation
----------------------------------------------------------
.. code-block:: python
pip install fantraxapi
Documentation_ can be found at Read the Docs.
.. _Documentation: https://fantraxapi.metamanager.wiki
Using the API
==========================================================
Getting a FantraxAPI Instance
----------------------------------------------------------
To connect to the Fantrax API you use the FantraxAPI object.
.. code-block:: python
from fantraxapi import FantraxAPI
league_id = "96igs4677sgjk7ol"
api = FantraxAPI(league_id)
.. code-block:: python
import fantraxapi
api = fantraxapi.FantraxAPI()
Usage Examples
==========================================================
Example: Get the Scores for the Season.
.. code-block:: python
from fantraxapi import FantraxAPI
league_id = "96igs4677sgjk7ol"
api = FantraxAPI(league_id)
for _, scoring_period in api.scoring_periods().items():
print("")
print(scoring_period)
Usage & Contributions
----------------------------------------------------------
* Source is available on the `Github Project Page <https://github.com/meisnate12/FantraxAPI>`_.
* Contributors to FantraxAPI own their own contributions and may distribute that code under
the `MIT license <https://github.com/meisnate12/FantraxAPI/blob/master/LICENSE.txt>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/meisnate12/FantraxAPI",
"name": "fantraxapi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "fantraxapi,fantrax,fantasy,wrapper,api",
"author": "Nathan Taggart",
"author_email": "meisnate12@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/53/8b/a1963d708ac655cb81fa88df0fb85c61ef24cffa0f3b1f8920e307df20ae/fantraxapi-0.2.7.tar.gz",
"platform": null,
"description": "Welcome to Fantrax Documentation!\n==========================================================\n\n.. image:: https://img.shields.io/github/v/release/meisnate12/FantraxAPI?style=plastic\n :target: https://github.com/meisnate12/FantraxAPI/releases\n :alt: GitHub release (latest by date)\n\n.. image:: https://img.shields.io/github/actions/workflow/status/meisnate12/FantraxAPI/tests.yml?branch=master&style=plastic\n :target: https://github.com/meisnate12/FantraxAPI/actions/workflows/tests.yml\n :alt: Build Testing\n\n.. image:: https://img.shields.io/codecov/c/github/meisnate12/FantraxAPI?color=greenred&style=plastic\n :target: https://codecov.io/gh/meisnate12/FantraxAPI\n :alt: Build Coverage\n\n.. image:: https://img.shields.io/github/commits-since/meisnate12/FantraxAPI/latest?style=plastic\n :target: https://github.com/meisnate12/FantraxAPI/commits/master\n :alt: GitHub commits since latest release (by date) for a branch\n\n.. image:: https://img.shields.io/pypi/v/FantraxAPI?style=plastic\n :target: https://pypi.org/project/FantraxAPI/\n :alt: PyPI\n\n.. image:: https://img.shields.io/pypi/dm/FantraxAPI.svg?style=plastic\n :target: https://pypi.org/project/FantraxAPI/\n :alt: Downloads\n\n.. image:: https://img.shields.io/readthedocs/plex-meta-manager?color=%2300bc8c&style=plastic\n :target: https://fantraxapi.metamanager.wiki/en/latest/\n :alt: Wiki\n\n.. image:: https://img.shields.io/discord/822460010649878528?color=%2300bc8c&label=Discord&style=plastic\n :target: https://discord.gg/NfH6mGFuAB\n :alt: Discord\n\n.. image:: https://img.shields.io/reddit/subreddit-subscribers/PlexMetaManager?color=%2300bc8c&label=r%2FPlexMetaManager&style=plastic\n :target: https://www.reddit.com/r/PlexMetaManager/\n :alt: Reddit\n\n.. image:: https://img.shields.io/github/sponsors/meisnate12?color=%238a2be2&style=plastic\n :target: https://github.com/sponsors/meisnate12\n :alt: GitHub Sponsors\n\n.. image:: https://img.shields.io/badge/-Sponsor_or_Donate-blueviolet?style=plastic\n :target: https://github.com/sponsors/meisnate12\n :alt: Sponsor or Donate\n\n\nOverview\n----------------------------------------------------------\nUnofficial Python bindings for the Fantrax API. The goal is to make interaction with the API as easy as possible while emulating the endpoints as much as possible\n\n\nInstallation & Documentation\n----------------------------------------------------------\n\n.. code-block:: python\n\n pip install fantraxapi\n\nDocumentation_ can be found at Read the Docs.\n\n.. _Documentation: https://fantraxapi.metamanager.wiki\n\n\nUsing the API\n==========================================================\n\nGetting a FantraxAPI Instance\n----------------------------------------------------------\n\nTo connect to the Fantrax API you use the FantraxAPI object.\n\n.. code-block:: python\n\n from fantraxapi import FantraxAPI\n\n league_id = \"96igs4677sgjk7ol\"\n\n api = FantraxAPI(league_id)\n\n\n.. code-block:: python\n\n import fantraxapi\n\n api = fantraxapi.FantraxAPI()\n\n\nUsage Examples\n==========================================================\n\nExample: Get the Scores for the Season.\n\n.. code-block:: python\n\n from fantraxapi import FantraxAPI\n\n league_id = \"96igs4677sgjk7ol\"\n\n api = FantraxAPI(league_id)\n\n for _, scoring_period in api.scoring_periods().items():\n print(\"\")\n print(scoring_period)\n\nUsage & Contributions\n----------------------------------------------------------\n\n* Source is available on the `Github Project Page <https://github.com/meisnate12/FantraxAPI>`_.\n* Contributors to FantraxAPI own their own contributions and may distribute that code under\n the `MIT license <https://github.com/meisnate12/FantraxAPI/blob/master/LICENSE.txt>`_.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A lightweight Python library for The Fantrax API.",
"version": "0.2.7",
"project_urls": {
"Documentation": "https://fantraxapi.metamanager.wiki",
"Funding": "https://github.com/sponsors/meisnate12",
"Homepage": "https://github.com/meisnate12/FantraxAPI",
"Issues": "https://github.com/meisnate12/FantraxAPI/issues",
"Source": "https://github.com/meisnate12/FantraxAPI"
},
"split_keywords": [
"fantraxapi",
"fantrax",
"fantasy",
"wrapper",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a75d6428a7ae398d4fb9d94875ee1797e9fdd063e0181339ad2eeb509bb1f57f",
"md5": "d6f35af6b5353e6a332f9ba83885b2a7",
"sha256": "c2da343f9abf615a24a0185155befa011c4be751d6ade37826a1f90da2fcb0c7"
},
"downloads": -1,
"filename": "fantraxapi-0.2.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6f35af6b5353e6a332f9ba83885b2a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9945,
"upload_time": "2024-03-10T20:50:59",
"upload_time_iso_8601": "2024-03-10T20:50:59.266193Z",
"url": "https://files.pythonhosted.org/packages/a7/5d/6428a7ae398d4fb9d94875ee1797e9fdd063e0181339ad2eeb509bb1f57f/fantraxapi-0.2.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "538ba1963d708ac655cb81fa88df0fb85c61ef24cffa0f3b1f8920e307df20ae",
"md5": "1f71c654389dc87542a174626f260e20",
"sha256": "a96402e9d5604e30edbeefcfc63ef06189dce1b8843de8842568dde934d7939e"
},
"downloads": -1,
"filename": "fantraxapi-0.2.7.tar.gz",
"has_sig": false,
"md5_digest": "1f71c654389dc87542a174626f260e20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11144,
"upload_time": "2024-03-10T20:51:01",
"upload_time_iso_8601": "2024-03-10T20:51:01.235692Z",
"url": "https://files.pythonhosted.org/packages/53/8b/a1963d708ac655cb81fa88df0fb85c61ef24cffa0f3b1f8920e307df20ae/fantraxapi-0.2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-10 20:51:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "meisnate12",
"github_project": "FantraxAPI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "fantraxapi"
}
JSON
