<div id="top"></div>
# PyPokeClasses
<p style="display: inline">
</p>
<p style="font-size : 16px">
PyPokeClasses is a Python package that provides a class-based structure for accessing and interacting with PokeAPI's JSON data. It simplifies the process of making API requests and handling the returned data, allowing developers to focus on building applications with Pokémon-related data.
</p>
<!-- プロジェクト名を記載 -->
## Features
<ul>
<li>
Class-based access to various Pokémon entities from PokeAPI.
</li>
<li>
Easy integration of PokeAPI into Python projects.
</li>
<li>
Structured handling of API responses.
</li>
<li>
Lightweight and flexible for various use cases.
</li>
</ul>
## Installation
You can install this package using pip:
```python
pip install PyPokeClasses
```
## Usage
Here is an example of how to use PyPokeClasses to fetch and interact with Pokémon data:
```
from PyPokeClasses.Pokemon import Pokemon
# Initialize a Pokemon instance by name or ID
pikachu = Pokemon('pikachu')
# Access basic information
print(f"Name: {pikachu.name}")
print(f"Height: {pikachu.height}")
print(f"Weight: {pikachu.weight}")
# Access additional data
print(f"Base Experience: {pikachu.base_experience}")
print(f"Types: {[t.type.name for t in pikachu.types]}")
```
Thanks to this design, the class dynamically fetches and stores the data in object properties, allowing users to easily access and interact with PokeAPI data directly from the class instance. Moreover, code completion (autocomplete) for these properties is supported, which enhances the development experience by suggesting available Pokémon attributes and methods during coding.
<h2> Supported Entities</h2>
| Entities | Classes | Links |
| -------------| ---------- | --------|
| Berries | Berry / BerryFirmness / BerryFlavor | [Link](https://pokeapi.co/docs/v2#berries-section)
| Contests | ContestType / ContestEffect / SuperContestEffect | [Link](https://pokeapi.co/docs/v2#contests-section)
| Encounters | EncounterMethod / EncounterCondition / EncounterConditionValue | [Link](https://pokeapi.co/docs/v2#encounters-section)
| Evolution | EvolutionChain / EvolutionTrigger | [Link](https://pokeapi.co/docs/v2#evolution-section)
| Games | Generation / Pokedex / Version / VersionGroup | [Link](https://pokeapi.co/docs/v2#games-section)
| Items | Item / ItemAttribute / ItemCategory / ItemFlingEffect / ItemPocket | [Link](https://pokeapi.co/docs/v2#items-section)
| Locations | Location / LocationArea / PalParkArea / Region | [Link](https://pokeapi.co/docs/v2#locations-section)
| Machines | Machine | [Link](https://pokeapi.co/docs/v2#machines-section)
| Moves | MoveAilments / MoveBattleStyles / MoveCategory /MoveDamageClass / MoveLearnMethod / Moves / MoveTarget | [Link](https://pokeapi.co/docs/v2#moves-section)
| Pokemon | Abilities / Characteristic / EggGroup / Genders / GrowthRate / Natures / PokeathlonStats / Pokemon / PokemonColors / PokemonForms / PokemonHabitats / PokemonShapes / PokemonSpecies / Stats / Types | [Link](https://pokeapi.co/docs/v2#locations-section)
## APIRefference
Each class within the package is mapped to the corresponding PokeAPI endpoint. Refer to the official <a href="https://pokeapi.co/">PokeAPI documentation</a> for details about the available data.
## LICENSE
This project is licensed under the MIT License - see the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/atama12/PyPokeClasses.git",
"name": "PyPokeClasses",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "PyPokeClasses pypokeclasses pokeAPI",
"author": "Atama12",
"author_email": "atama5860@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/29/d9/c8e7c2bbec3de1172e65a5f3872b5f1c395546ebf0c4bb0883e099833629/pypokeclasses-0.1.18.tar.gz",
"platform": null,
"description": "\r\n<div id=\"top\"></div>\r\n\r\n# PyPokeClasses\r\n\r\n<p style=\"display: inline\">\r\n\r\n</p>\r\n\r\n<p style=\"font-size : 16px\">\r\n PyPokeClasses is a Python package that provides a class-based structure for accessing and interacting with PokeAPI's JSON data. It simplifies the process of making API requests and handling the returned data, allowing developers to focus on building applications with Pok\u00e9mon-related data.\r\n</p>\r\n\r\n<!-- \u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u540d\u3092\u8a18\u8f09 -->\r\n\r\n## Features\r\n<ul>\r\n <li>\r\n Class-based access to various Pok\u00e9mon entities from PokeAPI.\r\n </li>\r\n <li>\r\n Easy integration of PokeAPI into Python projects.\r\n </li>\r\n <li>\r\n Structured handling of API responses.\r\n </li>\r\n <li>\r\n Lightweight and flexible for various use cases.\r\n </li>\r\n</ul>\r\n\r\n## Installation\r\n\r\nYou can install this package using pip:\r\n\r\n```python\r\npip install PyPokeClasses\r\n```\r\n\r\n## Usage\r\n\r\nHere is an example of how to use PyPokeClasses to fetch and interact with Pok\u00e9mon data:\r\n\r\n```\r\nfrom PyPokeClasses.Pokemon import Pokemon\r\n\r\n# Initialize a Pokemon instance by name or ID\r\npikachu = Pokemon('pikachu')\r\n\r\n# Access basic information\r\nprint(f\"Name: {pikachu.name}\")\r\nprint(f\"Height: {pikachu.height}\")\r\nprint(f\"Weight: {pikachu.weight}\")\r\n\r\n# Access additional data\r\nprint(f\"Base Experience: {pikachu.base_experience}\")\r\nprint(f\"Types: {[t.type.name for t in pikachu.types]}\")\r\n```\r\n\r\nThanks to this design, the class dynamically fetches and stores the data in object properties, allowing users to easily access and interact with PokeAPI data directly from the class instance. Moreover, code completion (autocomplete) for these properties is supported, which enhances the development experience by suggesting available Pok\u00e9mon attributes and methods during coding.\r\n\r\n\r\n\r\n<h2> Supported Entities</h2>\r\n\r\n| Entities | Classes | Links |\r\n| -------------| ---------- | --------|\r\n| Berries | Berry / BerryFirmness / BerryFlavor | [Link](https://pokeapi.co/docs/v2#berries-section)\r\n| Contests | ContestType / ContestEffect / SuperContestEffect | [Link](https://pokeapi.co/docs/v2#contests-section)\r\n| Encounters | EncounterMethod / EncounterCondition / EncounterConditionValue | [Link](https://pokeapi.co/docs/v2#encounters-section)\r\n| Evolution | EvolutionChain / EvolutionTrigger | [Link](https://pokeapi.co/docs/v2#evolution-section)\r\n| Games | Generation / Pokedex / Version / VersionGroup | [Link](https://pokeapi.co/docs/v2#games-section)\r\n| Items | Item / ItemAttribute / ItemCategory / ItemFlingEffect / ItemPocket | [Link](https://pokeapi.co/docs/v2#items-section)\r\n| Locations | Location / LocationArea / PalParkArea / Region | [Link](https://pokeapi.co/docs/v2#locations-section)\r\n| Machines | Machine | [Link](https://pokeapi.co/docs/v2#machines-section)\r\n| Moves | MoveAilments / MoveBattleStyles / MoveCategory /MoveDamageClass / MoveLearnMethod / Moves / MoveTarget | [Link](https://pokeapi.co/docs/v2#moves-section)\r\n| Pokemon | Abilities / Characteristic / EggGroup / Genders / GrowthRate / Natures / PokeathlonStats / Pokemon / PokemonColors / PokemonForms / PokemonHabitats / PokemonShapes / PokemonSpecies / Stats / Types | [Link](https://pokeapi.co/docs/v2#locations-section)\r\n\r\n## APIRefference\r\n\r\nEach class within the package is mapped to the corresponding PokeAPI endpoint. Refer to the official <a href=\"https://pokeapi.co/\">PokeAPI documentation</a> for details about the available data.\r\n\r\n## LICENSE\r\nThis project is licensed under the MIT License - see the LICENSE file for details.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A class-based Package for accessing and interacting with PokeAPI's JSON data.",
"version": "0.1.18",
"project_urls": {
"Homepage": "https://github.com/atama12/PyPokeClasses.git"
},
"split_keywords": [
"pypokeclasses",
"pypokeclasses",
"pokeapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "788fba3700727296e8fe26f98c279e59c1c6dd0fca1656d9aaa01262d4170540",
"md5": "df114a626fe406d29fbb75916ae617fa",
"sha256": "c604de615b5eda401649d3e1b95531390aa7be0201f1f86408e0d8a2b8c1ff1c"
},
"downloads": -1,
"filename": "PyPokeClasses-0.1.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df114a626fe406d29fbb75916ae617fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 40526,
"upload_time": "2024-09-15T18:57:08",
"upload_time_iso_8601": "2024-09-15T18:57:08.196890Z",
"url": "https://files.pythonhosted.org/packages/78/8f/ba3700727296e8fe26f98c279e59c1c6dd0fca1656d9aaa01262d4170540/PyPokeClasses-0.1.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29d9c8e7c2bbec3de1172e65a5f3872b5f1c395546ebf0c4bb0883e099833629",
"md5": "c5c3ca04d3564da4fdff68dfe1a9e2d4",
"sha256": "614b9671a7f05e3fdea589f523ab4c3e99d4c7634e2959c17950a5f3fa68a51a"
},
"downloads": -1,
"filename": "pypokeclasses-0.1.18.tar.gz",
"has_sig": false,
"md5_digest": "c5c3ca04d3564da4fdff68dfe1a9e2d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19771,
"upload_time": "2024-09-15T18:57:13",
"upload_time_iso_8601": "2024-09-15T18:57:13.389477Z",
"url": "https://files.pythonhosted.org/packages/29/d9/c8e7c2bbec3de1172e65a5f3872b5f1c395546ebf0c4bb0883e099833629/pypokeclasses-0.1.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-15 18:57:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "atama12",
"github_project": "PyPokeClasses",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pypokeclasses"
}
JSON
