{
"info": {
"author": "JDB",
"author_email": "JuxhinBox@gmail.com",
"bugtrack_url": null,
"classifiers": [],
"description": ".. figure:: https://raw.githubusercontent.com/JuxhinDB/gw2-api-interface/master/res/images/gw2-banner.jpg\n :alt: Guild Wars 2 Banner\n\n--------------\n\n\nGuildWars2 API Client\n=====================\n\n|Build Status|\n\n Library that interfaces with the Guild Wars 2 API that supports v1\n and v2 - https://wiki.guildwars2.com/wiki/API:Main\n\n \nTable of Contents\n=================\n\n- `Pre-requisites <#prerequisites>`__\n- `Installation <#installation>`__\n- `Usage <#usage>`__\n\n - `Basic Usage <#basic-usage>`__\n - `Advanced Usage <#advanced-usage>`__\n\n - `API Objects <#api-objects>`__\n - `Client Settings <#client-settings>`__\n - `Proxy and SSL <#proxy-and-ssl>`__\n\n - `Authenticated Endpoints <#authenticated-endpoints>`__\n - `Cursors and Limits <#cursors-and-limits>`__\n\n- `Examples <#examples>`__\n\n\nPrerequisites\n-------------\n\n- Python v3.4 or higher\n\n\nInstallation\n------------\n\nSee PyPi package `here `_:\n\n::\n\n pip install GuildWars2-API-Client\n\n::\n\n pip install git+https://github.com/JuxhinDB/gw2-api-interface.git#egg=gw2api\n\n\n\nUsage\n-----\n\n\nBasic Usage\n^^^^^^^^^^^\n\nInitializing a default client is simple. The following default values\nwill be automatically set for you:\n\n- API URL: https://api.guildwars2.com\n- Version: 2\n- Lang: en\n\nThus you can create a basic client like so:\n\n.. code-block:: python\n\n from gw2api import GuildWars2Client\n\n gw2_client = GuildWars2Client()\n\nThe format for accessing an object will always be\n``{client}.{object}.get()``. For example:\n\n.. code-block:: python\n\n gw2_client.build.get()\n\n::\n\n 81583\n\n\nAdvanced Usage\n^^^^^^^^^^^^^^\n\n\n**API Objects**\n\nThe client will automatically expose all the API objects available\ndepending on the API version. This can be done by calling the ``dir()``\nmethod on the client object, like so:\n\n.. code-block:: python\n\n gw2_client = GuildWars2Client(version='v1')\n dir(gw2_client)\n\n::\n\n ['BASE_URL', 'LANG', 'VERSION',\n 'api_key', 'base_url', 'build', 'colors', 'continents', 'eventdetails',\n 'files', 'guilddetails', 'itemdetails', 'items', 'lang', 'mapfloor',\n 'mapnames', 'maps', 'proxy', 'recipedetails', 'recipes', 'session',\n 'skindetails', 'skins', 'verify_ssl', 'version', 'worldnames',\n 'wvwmatchdetails', 'wvwmatches', 'wvwobjectivenames']\n\nAll redundant protocol-methods (i.e. ``__repr__``) were removed from the\noutput, you can ofcourse see the full output when running this in your\nproject.\n\n\n**Client Settings**\n\nTo examine the client settings at any given point, simply print the\nobject.\n\n.. code-block:: python\n\n from gw2api import GuildWars2Client\n gw2_client = GuildWars2Client()\n\n gw2_client\n\n::\n\n \n\n\n**Proxy and SSL**\n\nIf at any given point you need to pass API requests through proxy (e.g.\nFiddler) you can configure the client to pass all request through said\nproxy during client initialization.\n\n.. code-block:: python\n\n from gw2api import GuildWars2Client\n gw2_client = GuildWars2Client(proxy={'http': '127.0.0.1:8888', 'https': '127.0.0.1:8888'}, version='v1'})\n\nAdditionally if you're passing through a local proxy, you may need to\nset SSL verification to false like so:\n\n.. code-block:: python\n\n from gw2api import GuildWars2Client\n gw2_client = GuildWars2Client(proxy={'http': '127.0.0.1:8888', 'https': '127.0.0.1:8888'}, version='v1', verify_ssl=False)\n\n\nAuthenticated Endpoints\n^^^^^^^^^^^^^^^^^^^^^^^\n\nThere may be cases where certain endpoints such as ``Accounts`` or\n``Guild`` related endpoints may require authentication. This is\ngenerally configured on initialization of the client, like so:\n\n.. code-block:: python\n\n client = GuildWars2Client(api_key='API_KEY_VALUE_HERE')\n\nIf you want to generate your own API key, please refer to the following\n`link `__.\n\n\nCursors and Limits\n^^^^^^^^^^^^^^^^^^\n\nWIP\n\n\nExamples\n~~~~~~~~\n\nBelow are a few examples and one-liners that may help when testing or\ndebugging the project:\n\n\n**Using** `Fiddler `__:\n\n.. code-block:: python\n\n from gw2api import GuildWars2Client\n client = GuildWars2Client(proxy={'http': '127.0.0.1:8888', 'https': '127.0.0.1:8888'}, verify_ssl=False, api_key='API_KEY')\n\n\n**APIv2 Searching for Guild**\n\n.. code-block:: python\n\n client.guildsearch.get(name='Mythical Realms')\n\n::\n\n 0CB3B1A7-4C70-E611-80D3-E4115BE8BBE8\n\n\n**APIv2 Retrieving guild members**\n\n.. code-block:: python\n\n client.guildidmembers.get('0CB3B1A7-4C70-E611-80D3-E4115BE8BBE8')\n\n::\n\n {\"text\": \"access restricted to guild leaders\"} # :-(\n\n\n.. |Build Status| image:: https://travis-ci.org/JuxhinDB/gw2-api-interface.svg?branch=feature%2Fapi-requests\n :target: https://travis-ci.org/JuxhinDB/gw2-api-interface",
"description_content_type": "",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/JuxhinDB/gw2-api-interface",
"keywords": "guildwars 2,api,gw2",
"license": "MIT",
"maintainer": "",
"maintainer_email": "",
"name": "GuildWars2-API-Client",
"package_url": "https://pypi.org/project/GuildWars2-API-Client/",
"platform": "",
"project_url": "https://pypi.org/project/GuildWars2-API-Client/",
"project_urls": {
"Homepage": "https://github.com/JuxhinDB/gw2-api-interface"
},
"release_url": "https://pypi.org/project/GuildWars2-API-Client/0.5.9/",
"requires_dist": null,
"requires_python": "",
"summary": "Library that interfaces with the Guild Wars 2 API that supports v1 and v2",
"version": "0.5.9"
},
"last_serial": 4053945,
"releases": {
"0.5.2": [
{
"comment_text": "",
"digests": {
"md5": "498c11554379024d3d5834685338cdd4",
"sha256": "8ba2bc5ee17ea55281e68636d53a3bf5de6d20b8e6a620ab1bf049ab4b0c1b5c"
},
"downloads": -1,
"filename": "GuildWars2 API Client-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "498c11554379024d3d5834685338cdd4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10952,
"upload_time": "2018-06-06T11:35:20",
"url": "https://files.pythonhosted.org/packages/9c/92/cc10f82c809e16fea9eab44980704b5a09e9ee50b9190af86fca7497be80/GuildWars2%20API%20Client-0.5.2.tar.gz"
}
],
"0.5.3": [
{
"comment_text": "",
"digests": {
"md5": "418ba14f5da26be4d2e202bf2737099e",
"sha256": "9f82b920ad45e2d86b596affeffea517e11772e051e30b7eb32faaf3191a3652"
},
"downloads": -1,
"filename": "GuildWars2 API Client-0.5.3.tar.gz",
"has_sig": false,
"md5_digest": "418ba14f5da26be4d2e202bf2737099e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11096,
"upload_time": "2018-06-18T06:34:52",
"url": "https://files.pythonhosted.org/packages/8e/dc/cd2c4b2823b440ef82f2f9e188b6cafa586f0b6c78e088fdebd26b0aabc1/GuildWars2%20API%20Client-0.5.3.tar.gz"
}
],
"0.5.5": [
{
"comment_text": "",
"digests": {
"md5": "2d14d4fa9565829ebccd731ef12b4573",
"sha256": "2936b7d54f11205b13aeadc4c5b0f9624d36680da064dd6152bcb37583b7f4d8"
},
"downloads": -1,
"filename": "GuildWars2-API-Client-0.5.5.tar.gz",
"has_sig": false,
"md5_digest": "2d14d4fa9565829ebccd731ef12b4573",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11096,
"upload_time": "2018-06-18T12:04:51",
"url": "https://files.pythonhosted.org/packages/f1/54/3c33d6141069443a2c5d295bcaf391f87490f96b9eea32f44ae2dbafaaba/GuildWars2-API-Client-0.5.5.tar.gz"
}
],
"0.5.7": [
{
"comment_text": "",
"digests": {
"md5": "055bd423bad9ed4ec9f96df9403bacde",
"sha256": "d38fa53c3220b5a550965fabdaead917c8f7d3f0a92f069de6a3770f41cae9e9"
},
"downloads": -1,
"filename": "GuildWars2-API-Client-0.5.7.tar.gz",
"has_sig": false,
"md5_digest": "055bd423bad9ed4ec9f96df9403bacde",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10260,
"upload_time": "2018-06-18T13:34:32",
"url": "https://files.pythonhosted.org/packages/80/30/3bb3a3b1a6e94bfe4b4b90afbfe160841c7f279f0cfd5f320ef56b859966/GuildWars2-API-Client-0.5.7.tar.gz"
}
],
"0.5.8": [
{
"comment_text": "",
"digests": {
"md5": "0b970f04c6b85ee43ee14f51fe7143fa",
"sha256": "9c5a075d5279b607d83a06564b5076ad8ec9e37046e3acd1ed35f54d4a706b6d"
},
"downloads": -1,
"filename": "GuildWars2-API-Client-0.5.8.tar.gz",
"has_sig": false,
"md5_digest": "0b970f04c6b85ee43ee14f51fe7143fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14253,
"upload_time": "2018-06-20T13:17:27",
"url": "https://files.pythonhosted.org/packages/b2/9c/8588e18d557b572b2395980c40e0d46d7a838a8da35ccf617ef0a5349a99/GuildWars2-API-Client-0.5.8.tar.gz"
}
],
"0.5.9": [
{
"comment_text": "",
"digests": {
"md5": "8446400215d8b3571f4d947ed09b0cc5",
"sha256": "8afde636872bf466e30159cb05aa6e03c35c5f05a787f6a47601b78908d41822"
},
"downloads": -1,
"filename": "GuildWars2-API-Client-0.5.9.tar.gz",
"has_sig": false,
"md5_digest": "8446400215d8b3571f4d947ed09b0cc5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15324,
"upload_time": "2018-07-12T11:18:17",
"url": "https://files.pythonhosted.org/packages/48/50/14d90199c75bae00ee8741093c633b1d42baaf8d4214d2c2782cd83f8b6c/GuildWars2-API-Client-0.5.9.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "8446400215d8b3571f4d947ed09b0cc5",
"sha256": "8afde636872bf466e30159cb05aa6e03c35c5f05a787f6a47601b78908d41822"
},
"downloads": -1,
"filename": "GuildWars2-API-Client-0.5.9.tar.gz",
"has_sig": false,
"md5_digest": "8446400215d8b3571f4d947ed09b0cc5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15324,
"upload_time": "2018-07-12T11:18:17",
"url": "https://files.pythonhosted.org/packages/48/50/14d90199c75bae00ee8741093c633b1d42baaf8d4214d2c2782cd83f8b6c/GuildWars2-API-Client-0.5.9.tar.gz"
}
]
}