| Name | TornAPIWrapper JSON |
| Version |
1.0.3
JSON |
| download |
| home_page | |
| Summary | A Python wrapper for the Torn City API, providing access to Torn City data. |
| upload_time | 2023-12-14 23:14:59 |
| maintainer | |
| docs_url | None |
| author | cxdzc |
| requires_python | >=3.8 |
| license | |
| keywords |
torn
torn-city
torn-city-api
torncom
wrapper
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<a href="https://pypi.org/project/TornAPIWrapper/"><img src=https://img.shields.io/pypi/v/TornAPIWrapper.svg></a>
<a href="https://pypi.org/project/TornAPIWrapper/"><img src=https://img.shields.io/pypi/pyversions/TornAPIWrapper.svg></a>
</p>
# 📦 TornAPIWrapper v1.0.3
A Python wrapper for the [Torn City API](https://www.torn.com/api.html), providing access to [Torn City](https://www.torn.com) data.
# 📠 Instructions
1. Install the [TornAPIWrapper](https://pypi.org/project/TornAPIWrapper) package by typing `pip install tornapiwrapper` in your CMD.
2. Check out [examples](https://github.com/cxdzc/TornAPIWrapper/tree/main/Examples) and [documentations](https://github.com/cxdzc/TornAPIWrapper#-documentations) to familiarize yourself with the API.
3. Create an [API key](https://www.torn.com/preferences.php#tab=api).
4. Start programming!
# 📑 Documentations
There are two Torn City API documentations that I recommend reading to understand how the API works.
- **[Official Torn API Docs](https://www.torn.com/api.html):** This is the official Torn City API documentation, that is not properly documented. I only recommend this as it is official documentation.
<br><br>
- **[Unofficial Torn API Docs](https://tornapi.tornplayground.eu):** This is the unofficial Torn City API documentation, that is well documented and has an active and open-source [repository](https://github.com/Torn-Playground/tornapi-documentation).
# 💝 Contributors
<a href="https://github.com/cxdzc/tornapiwrapper/graphs/contributors">
<img width="75" src="https://contrib.rocks/image?repo=cxdzc/tornapiwrapper"/>
</a>
# 💌 Support
Love open-source projects? Find the project helpful or fun? Support sustainability here, your contribution keeps innovation and fun alive.
<a rel="license" href="https://www.buymeacoffee.com/cxdzc"><img width="200" alt="bmc-button" src="https://github.com/cxdzc/TornAPIWrapper/assets/110936008/494a782f-e327-4d07-8821-e962f03842e4"></a>
# 📜 License
> [!NOTE]
> This is not legal advice.
The content and software in this GitHub repository are licensed under the [MIT License](https://github.com/cxdzc/TornAPIWrapper/blob/main/LICENSE). A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.
<a rel="license" href="https://github.com/cxdzc/TornAPIWrapper/blob/main/LICENSE"><img alt="MIT License" src="https://img.shields.io/badge/License-MIT-ab1436"/></a>
# 🔗 Links
These are links that may help with your programming.
- [List of Torn City item IDs](https://www.tornstats.com/items)
Raw data
{
"_id": null,
"home_page": "",
"name": "TornAPIWrapper",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "torn,torn-city,torn-city-api,torncom,wrapper,api",
"author": "cxdzc",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/9a/6a/fac92b698453f1c8b2a74cf458b17c263ea06b42e94c9badfe5237ce6b82/TornAPIWrapper-1.0.3.tar.gz",
"platform": null,
"description": "\n\n<p align=\"center\">\n<a href=\"https://pypi.org/project/TornAPIWrapper/\"><img src=https://img.shields.io/pypi/v/TornAPIWrapper.svg></a>\n<a href=\"https://pypi.org/project/TornAPIWrapper/\"><img src=https://img.shields.io/pypi/pyversions/TornAPIWrapper.svg></a>\n</p>\n\n# \ud83d\udce6 TornAPIWrapper v1.0.3\nA Python wrapper for the [Torn City API](https://www.torn.com/api.html), providing access to [Torn City](https://www.torn.com) data.\n\n# \ud83d\udce0 Instructions\n1. Install the [TornAPIWrapper](https://pypi.org/project/TornAPIWrapper) package by typing `pip install tornapiwrapper` in your CMD.\n2. Check out [examples](https://github.com/cxdzc/TornAPIWrapper/tree/main/Examples) and [documentations](https://github.com/cxdzc/TornAPIWrapper#-documentations) to familiarize yourself with the API.\n3. Create an [API key](https://www.torn.com/preferences.php#tab=api).\n4. Start programming!\n\n# \ud83d\udcd1 Documentations\nThere are two Torn City API documentations that I recommend reading to understand how the API works.\n\n- **[Official Torn API Docs](https://www.torn.com/api.html):** This is the official Torn City API documentation, that is not properly documented. I only recommend this as it is official documentation.\n<br><br>\n- **[Unofficial Torn API Docs](https://tornapi.tornplayground.eu):** This is the unofficial Torn City API documentation, that is well documented and has an active and open-source [repository](https://github.com/Torn-Playground/tornapi-documentation).\n\n# \ud83d\udc9d Contributors\n<a href=\"https://github.com/cxdzc/tornapiwrapper/graphs/contributors\">\n <img width=\"75\" src=\"https://contrib.rocks/image?repo=cxdzc/tornapiwrapper\"/>\n</a>\n\n# \ud83d\udc8c Support\nLove open-source projects? Find the project helpful or fun? Support sustainability here, your contribution keeps innovation and fun alive.\n\n<a rel=\"license\" href=\"https://www.buymeacoffee.com/cxdzc\"><img width=\"200\" alt=\"bmc-button\" src=\"https://github.com/cxdzc/TornAPIWrapper/assets/110936008/494a782f-e327-4d07-8821-e962f03842e4\"></a>\n\n# \ud83d\udcdc License\n> [!NOTE]\n> This is not legal advice.\n\nThe content and software in this GitHub repository are licensed under the [MIT License](https://github.com/cxdzc/TornAPIWrapper/blob/main/LICENSE). A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.\n\n<a rel=\"license\" href=\"https://github.com/cxdzc/TornAPIWrapper/blob/main/LICENSE\"><img alt=\"MIT License\" src=\"https://img.shields.io/badge/License-MIT-ab1436\"/></a>\n\n# \ud83d\udd17 Links\nThese are links that may help with your programming.\n\n- [List of Torn City item IDs](https://www.tornstats.com/items)\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python wrapper for the Torn City API, providing access to Torn City data.",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/cxdzc/TornAPIWrapper",
"Issues": "https://github.com/cxdzc/TornAPIWrapper/issues",
"Repository": "https://github.com/cxdzc/TornAPIWrapper"
},
"split_keywords": [
"torn",
"torn-city",
"torn-city-api",
"torncom",
"wrapper",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "46d09fb40244c4c69c67c3c7464ef6a553fa4b15631a5d775b8809c7ba9768b0",
"md5": "e71b5b5d3de783315f6ddea884b23de2",
"sha256": "7c4fc9aa8ad7e2b580bb8a23215ca474e002b4115bbcff3ede774b68c8f7da27"
},
"downloads": -1,
"filename": "TornAPIWrapper-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e71b5b5d3de783315f6ddea884b23de2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7692,
"upload_time": "2023-12-14T23:14:57",
"upload_time_iso_8601": "2023-12-14T23:14:57.580130Z",
"url": "https://files.pythonhosted.org/packages/46/d0/9fb40244c4c69c67c3c7464ef6a553fa4b15631a5d775b8809c7ba9768b0/TornAPIWrapper-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a6afac92b698453f1c8b2a74cf458b17c263ea06b42e94c9badfe5237ce6b82",
"md5": "10ce17c2dee31386f543a915485c2f40",
"sha256": "4d238e3e4dc41dd9748a33e5cce312f842a83adee60162e10651a5630aaf383a"
},
"downloads": -1,
"filename": "TornAPIWrapper-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "10ce17c2dee31386f543a915485c2f40",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6763,
"upload_time": "2023-12-14T23:14:59",
"upload_time_iso_8601": "2023-12-14T23:14:59.370659Z",
"url": "https://files.pythonhosted.org/packages/9a/6a/fac92b698453f1c8b2a74cf458b17c263ea06b42e94c9badfe5237ce6b82/TornAPIWrapper-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-14 23:14:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cxdzc",
"github_project": "TornAPIWrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tornapiwrapper"
}
