warframe.py


Namewarframe.py JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/WFCD/warframe.py
SummaryAn asynchronous Python API wrapper for the Warframestat API and (later) the warframe.market API.
upload_time2023-09-09 22:33:06
maintainer
docs_urlNone
authorMettwasser
requires_python>=3.9.0
licenseMIT
keywords warframe api worldstate market wrapper
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            warframe.py
===========
.. image:: https://img.shields.io/pypi/v/warframe.py.svg
   :target: https://pypi.python.org/pypi/warframe.py
   :alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/warframe.py.svg
   :target: https://pypi.python.org/pypi/warframe.py
   :alt: PyPI supported Python versions
.. image:: https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release
   :target: https://github.com/semantic-release/semantic-release
   :alt: semantic-release: angular

An asynchronous and typed Python API wrapper for `the Warframestat API <https://hub.warframestat.us>`__ and (later) `the warframe.market API <https://warframe.market/api_docs>`__.

What to expect
--------------

This library is in its early states. The goal is to make it the best and most up-to-date Python Warframe API wrapper.

Quickstart
----------

.. code-block:: python

    
    import asyncio
    import logging

    from warframe.worldstate import WorldstateClient, utils

    # import the models you want to use
    from warframe.worldstate.models import Cetus

    async def main():
        # Note that the default logger is pretty much empty (nothing will be logged)
        # so if you want to make use of the logger, you can use this helper function:
        utils.setup_logging(handler=logging.StreamHandler(), level=logging.DEBUG, root=True)

        async with WorldstateClient() as client:
            # get current cetus data
            cetus = await client.get_cetus()

            # or... get it like this:

            # queries are just another way to get the data to the corresponding objects.
            # this is really just personal preference.
            cetus = await client.query(Cetus)

            print(cetus)


    if __name__ == "__main__":
        loop = asyncio.new_event_loop()
        loop.run_until_complete(main())



Installing
----------

To install the library, use the following command:

.. code-block:: bash

    pip install warframe.py

Supported python versions:

- 3.11
- 3.10
- 3.9

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/WFCD/warframe.py",
    "name": "warframe.py",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9.0",
    "maintainer_email": "",
    "keywords": "Warframe API worldstate market wrapper",
    "author": "Mettwasser",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/db/7f/fd7f91bcb45effedf4dd1b5be9e79da10fef5dfffe45a774d3b500eb7b72/warframe.py-1.1.0.tar.gz",
    "platform": null,
    "description": "warframe.py\n===========\n.. image:: https://img.shields.io/pypi/v/warframe.py.svg\n   :target: https://pypi.python.org/pypi/warframe.py\n   :alt: PyPI version info\n.. image:: https://img.shields.io/pypi/pyversions/warframe.py.svg\n   :target: https://pypi.python.org/pypi/warframe.py\n   :alt: PyPI supported Python versions\n.. image:: https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release\n   :target: https://github.com/semantic-release/semantic-release\n   :alt: semantic-release: angular\n\nAn asynchronous and typed Python API wrapper for `the Warframestat API <https://hub.warframestat.us>`__ and (later) `the warframe.market API <https://warframe.market/api_docs>`__.\n\nWhat to expect\n--------------\n\nThis library is in its early states. The goal is to make it the best and most up-to-date Python Warframe API wrapper.\n\nQuickstart\n----------\n\n.. code-block:: python\n\n    \n    import asyncio\n    import logging\n\n    from warframe.worldstate import WorldstateClient, utils\n\n    # import the models you want to use\n    from warframe.worldstate.models import Cetus\n\n    async def main():\n        # Note that the default logger is pretty much empty (nothing will be logged)\n        # so if you want to make use of the logger, you can use this helper function:\n        utils.setup_logging(handler=logging.StreamHandler(), level=logging.DEBUG, root=True)\n\n        async with WorldstateClient() as client:\n            # get current cetus data\n            cetus = await client.get_cetus()\n\n            # or... get it like this:\n\n            # queries are just another way to get the data to the corresponding objects.\n            # this is really just personal preference.\n            cetus = await client.query(Cetus)\n\n            print(cetus)\n\n\n    if __name__ == \"__main__\":\n        loop = asyncio.new_event_loop()\n        loop.run_until_complete(main())\n\n\n\nInstalling\n----------\n\nTo install the library, use the following command:\n\n.. code-block:: bash\n\n    pip install warframe.py\n\nSupported python versions:\n\n- 3.11\n- 3.10\n- 3.9\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An asynchronous Python API wrapper for the Warframestat API and (later) the warframe.market API.",
    "version": "1.1.0",
    "project_urls": {
        "Homepage": "https://github.com/WFCD/warframe.py"
    },
    "split_keywords": [
        "warframe",
        "api",
        "worldstate",
        "market",
        "wrapper"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "48f5a2cdc4f100db90e8c76941ce01515a3830da2ec917564ecd4ed7d37da21a",
                "md5": "3ae4755da74d8459f148c2f41aed978a",
                "sha256": "60719b04f750239af42aad25f9985505dd554d17a0568ceea36641ca00922daa"
            },
            "downloads": -1,
            "filename": "warframe.py-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3ae4755da74d8459f148c2f41aed978a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9.0",
            "size": 24270,
            "upload_time": "2023-09-09T22:33:04",
            "upload_time_iso_8601": "2023-09-09T22:33:04.796913Z",
            "url": "https://files.pythonhosted.org/packages/48/f5/a2cdc4f100db90e8c76941ce01515a3830da2ec917564ecd4ed7d37da21a/warframe.py-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "db7ffd7f91bcb45effedf4dd1b5be9e79da10fef5dfffe45a774d3b500eb7b72",
                "md5": "913bd423e6b5d79f1b212b4400153ccc",
                "sha256": "7d6115577ef5a7b5a90a9de230d8dd3d354938435d10cb43842d257c5ad28fc5"
            },
            "downloads": -1,
            "filename": "warframe.py-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "913bd423e6b5d79f1b212b4400153ccc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9.0",
            "size": 16140,
            "upload_time": "2023-09-09T22:33:06",
            "upload_time_iso_8601": "2023-09-09T22:33:06.014267Z",
            "url": "https://files.pythonhosted.org/packages/db/7f/fd7f91bcb45effedf4dd1b5be9e79da10fef5dfffe45a774d3b500eb7b72/warframe.py-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-09 22:33:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "WFCD",
    "github_project": "warframe.py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "warframe.py"
}
        
Elapsed time: 0.11895s