endfield-py 1.0.0__tar.gz

endfield_py-1.0.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sora
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

endfield_py-1.0.0/PKG-INFO

@@ -0,0 +1,267 @@
+Metadata-Version: 2.4
+Name: endfield-py
+Version: 1.0.0
+Summary: A Python library for fetching player data from the Enka Network API.
+Author-email: sora <sahikast07@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 sora
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: asyncio
+Dynamic: license-file
+
+# Endfield
+
+A Python library for fetching and parsing player data from the Enka Network API for **Endfield**.
+
+[![PyPI version](https://img.shields.io/pypi/v/endfield-py.svg)](https://pypi.org/project/endfield-py/)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
+
+## Overview
+
+**Endfield** is an async Python library that provides easy access to player game data from the Enka Network API. It allows developers to retrieve comprehensive information about players, their characters, weapons, equipment, and computed statistics.
+
+## Features
+
+-  **Async Support**: Built with asyncio for efficient concurrent requests
+-  **Complete Data Models**: Pydantic-based models for type-safe data handling
+-  **Player Showcase Data**: Fetch player profiles and their character showcases
+-  **Character Information**: Get detailed character data including skills, talents, and stats
+-  **Equipment & Weapons**: Access equipment and weapon information
+-  **Stat Computation**: Calculate final character statistics with modifiers
+-  **Asset Resolution**: Built-in asset resolution with local JSON data
+-  **Update Checking**: Check for and download library updates
+-  **Session Management**: Flexible session handling with context managers
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install endfield-py
+```
+
+### From GitHub
+
+```bash
+pip install git+https://github.com/MR-LORD-REX/endfield.git
+```
+
+### Manual Installation
+
+```bash
+git clone https://github.com/MR-LORD-REX/endfield.git
+cd endfield
+pip install -e .
+```
+
+## Requirements
+
+- Python 3.8+
+- aiohttp >= 3.8.0
+- pydantic >= 2.0.0
+
+## Quick Start
+
+### Basic Usage
+
+```python
+import asyncio
+from endfield import Endfield
+
+async def main():
+    async with Endfield() as client:
+        # Fetch player showcase data
+        showcase = await client.get_showcase(uid=4225399080)
+        print(showcase)
+
+asyncio.run(main())
+```
+
+
+### Enable Debug Logging
+
+```python
+async with Endfield(debug=True) as client:
+    showcase = await client.get_showcase(uid=4225399080)
+```
+
+## API Reference
+
+### Endfield Client
+
+#### Constructor
+
+```python
+Endfield(
+    session: Optional[aiohttp.ClientSession] = None,
+    debug: bool = False
+)
+```
+
+**Parameters:**
+
+- `session`: Optional external aiohttp session
+- `debug`: Enable debug logging (default: False)
+
+#### Methods
+
+##### `get_showcase(uid: int | str)`
+
+Fetch player showcase data including characters, equipment, and weapons.
+
+```python
+showcase = await client.get_showcase(uid=4225399080)
+```
+
+**Returns:** `ShowcaseData` - Player showcase information
+
+##### `check_for_updates()`
+
+Check for library updates.
+
+```python
+await client.check_for_updates()
+```
+
+##### `close()`
+
+Close the client session.
+
+```python
+await client.close()
+```
+
+## Data Models
+
+The library provides comprehensive Pydantic models for type-safe data handling:
+
+- **ShowcaseData**: Complete player showcase information
+- **PlayerProfile**: Player account information
+- **ProfileCharacter**: Character showcase data
+- **CharacterData**: Detailed character information including skills and talents
+- **WeaponData**: Weapon information and skills
+- **EquipData**: Equipment data with stat modifiers
+- **ComputedStats**: Final calculated character statistics
+
+## Examples
+
+### Fetch Player Profile
+
+```python
+async with Endfield() as client:
+    showcase = await client.get_showcase(uid="your_uid_here")
+    profile = showcase.player_info
+    print(f"Player: {profile.player_name}")
+    print(f"Level: {profile.level}")
+```
+
+### Get Character Information
+
+```python
+async with Endfield() as client:
+    showcase = await client.get_showcase(uid="your_uid_here")
+    for char in showcase.characters:
+        print(f"Character: {char.name}")
+        print(f"Level: {char.level}")
+        print(f"Stats: {char.stats}")
+```
+
+### Check Weapon Information
+
+```python
+async with Endfield() as client:
+    showcase = await client.get_showcase(uid="your_uid_here")
+    for char in showcase.characters:
+        if char.weapon:
+            print(f"{char.name}'s Weapon: {char.weapon.name}")
+            print(f"Level: {char.weapon.level}")
+```
+
+## Error Handling
+
+The library provides specific exceptions for error handling:
+
+```python
+from endfield.errors import APIError, CharacterNotFoundError, WeaponNotFoundError
+
+try:
+    async with Endfield() as client:
+        showcase = await client.get_showcase(uid="invalid_uid")
+except APIError as e:
+    print(f"API Error: {e}")
+except CharacterNotFoundError as e:
+    print(f"Character not found: {e}")
+except WeaponNotFoundError as e:
+    print(f"Weapon not found: {e}")
+```
+
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit pull requests or open issues on the [GitHub repository](https://github.com/MR-LORD-REX/endfield).
+
+### Development Setup
+
+```bash
+git clone https://github.com/MR-LORD-REX/endfield.git
+cd endfield
+pip install -e .
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details.
+
+## Disclaimer
+
+This is an unofficial library. Endfield is a trademark of their respective owners. This library is not affiliated with or endorsed by the game developers. Use this library responsibly and in accordance with the Enka Network API terms of service.
+
+## Support
+
+For issues, questions, or suggestions, please open an issue on the [GitHub repository](https://github.com/MR-LORD-REX/endfield/issues).
+
+## Credits
+
+- Built by [MR-LORD-REX](https://github.com/MR-LORD-REX) , [telegram](https://t.me/The_Prime_Mover)
+- Data source: [Enka Network](https://enka.network)
+
+## Changelog
+
+### Version 1.0.0
+
+- Initial release
+- Basic player data fetching
+- Character, weapon, and equipment support
+- Stat computation
+- Update checking
+
+---
+
+## NOTE 
+
+- Computation of final character stats are done by the currently known formulas, some of them might be inaccurate , feel free to contribute if you encounter any discrepancies or have suggestions for improvement.
+
+**Happy Endfielding**

endfield_py-1.0.0/README.md

@@ -0,0 +1,233 @@
+# Endfield
+
+A Python library for fetching and parsing player data from the Enka Network API for **Endfield**.
+
+[![PyPI version](https://img.shields.io/pypi/v/endfield-py.svg)](https://pypi.org/project/endfield-py/)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
+
+## Overview
+
+**Endfield** is an async Python library that provides easy access to player game data from the Enka Network API. It allows developers to retrieve comprehensive information about players, their characters, weapons, equipment, and computed statistics.
+
+## Features
+
+-  **Async Support**: Built with asyncio for efficient concurrent requests
+-  **Complete Data Models**: Pydantic-based models for type-safe data handling
+-  **Player Showcase Data**: Fetch player profiles and their character showcases
+-  **Character Information**: Get detailed character data including skills, talents, and stats
+-  **Equipment & Weapons**: Access equipment and weapon information
+-  **Stat Computation**: Calculate final character statistics with modifiers
+-  **Asset Resolution**: Built-in asset resolution with local JSON data
+-  **Update Checking**: Check for and download library updates
+-  **Session Management**: Flexible session handling with context managers
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install endfield-py
+```
+
+### From GitHub
+
+```bash
+pip install git+https://github.com/MR-LORD-REX/endfield.git
+```
+
+### Manual Installation
+
+```bash
+git clone https://github.com/MR-LORD-REX/endfield.git
+cd endfield
+pip install -e .
+```
+
+## Requirements
+
+- Python 3.8+
+- aiohttp >= 3.8.0
+- pydantic >= 2.0.0
+
+## Quick Start
+
+### Basic Usage
+
+```python
+import asyncio
+from endfield import Endfield
+
+async def main():
+    async with Endfield() as client:
+        # Fetch player showcase data
+        showcase = await client.get_showcase(uid=4225399080)
+        print(showcase)
+
+asyncio.run(main())
+```
+
+
+### Enable Debug Logging
+
+```python
+async with Endfield(debug=True) as client:
+    showcase = await client.get_showcase(uid=4225399080)
+```
+
+## API Reference
+
+### Endfield Client
+
+#### Constructor
+
+```python
+Endfield(
+    session: Optional[aiohttp.ClientSession] = None,
+    debug: bool = False
+)
+```
+
+**Parameters:**
+
+- `session`: Optional external aiohttp session
+- `debug`: Enable debug logging (default: False)
+
+#### Methods
+
+##### `get_showcase(uid: int | str)`
+
+Fetch player showcase data including characters, equipment, and weapons.
+
+```python
+showcase = await client.get_showcase(uid=4225399080)
+```
+
+**Returns:** `ShowcaseData` - Player showcase information
+
+##### `check_for_updates()`
+
+Check for library updates.
+
+```python
+await client.check_for_updates()
+```
+
+##### `close()`
+
+Close the client session.
+
+```python
+await client.close()
+```
+
+## Data Models
+
+The library provides comprehensive Pydantic models for type-safe data handling:
+
+- **ShowcaseData**: Complete player showcase information
+- **PlayerProfile**: Player account information
+- **ProfileCharacter**: Character showcase data
+- **CharacterData**: Detailed character information including skills and talents
+- **WeaponData**: Weapon information and skills
+- **EquipData**: Equipment data with stat modifiers
+- **ComputedStats**: Final calculated character statistics
+
+## Examples
+
+### Fetch Player Profile
+
+```python
+async with Endfield() as client:
+    showcase = await client.get_showcase(uid="your_uid_here")
+    profile = showcase.player_info
+    print(f"Player: {profile.player_name}")
+    print(f"Level: {profile.level}")
+```
+
+### Get Character Information
+
+```python
+async with Endfield() as client:
+    showcase = await client.get_showcase(uid="your_uid_here")
+    for char in showcase.characters:
+        print(f"Character: {char.name}")
+        print(f"Level: {char.level}")
+        print(f"Stats: {char.stats}")
+```
+
+### Check Weapon Information
+
+```python
+async with Endfield() as client:
+    showcase = await client.get_showcase(uid="your_uid_here")
+    for char in showcase.characters:
+        if char.weapon:
+            print(f"{char.name}'s Weapon: {char.weapon.name}")
+            print(f"Level: {char.weapon.level}")
+```
+
+## Error Handling
+
+The library provides specific exceptions for error handling:
+
+```python
+from endfield.errors import APIError, CharacterNotFoundError, WeaponNotFoundError
+
+try:
+    async with Endfield() as client:
+        showcase = await client.get_showcase(uid="invalid_uid")
+except APIError as e:
+    print(f"API Error: {e}")
+except CharacterNotFoundError as e:
+    print(f"Character not found: {e}")
+except WeaponNotFoundError as e:
+    print(f"Weapon not found: {e}")
+```
+
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit pull requests or open issues on the [GitHub repository](https://github.com/MR-LORD-REX/endfield).
+
+### Development Setup
+
+```bash
+git clone https://github.com/MR-LORD-REX/endfield.git
+cd endfield
+pip install -e .
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details.
+
+## Disclaimer
+
+This is an unofficial library. Endfield is a trademark of their respective owners. This library is not affiliated with or endorsed by the game developers. Use this library responsibly and in accordance with the Enka Network API terms of service.
+
+## Support
+
+For issues, questions, or suggestions, please open an issue on the [GitHub repository](https://github.com/MR-LORD-REX/endfield/issues).
+
+## Credits
+
+- Built by [MR-LORD-REX](https://github.com/MR-LORD-REX) , [telegram](https://t.me/The_Prime_Mover)
+- Data source: [Enka Network](https://enka.network)
+
+## Changelog
+
+### Version 1.0.0
+
+- Initial release
+- Basic player data fetching
+- Character, weapon, and equipment support
+- Stat computation
+- Update checking
+
+---
+
+## NOTE 
+
+- Computation of final character stats are done by the currently known formulas, some of them might be inaccurate , feel free to contribute if you encounter any discrepancies or have suggestions for improvement.
+
+**Happy Endfielding**

endfield_py-1.0.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires=["setuptools>=61.0"]
+build-backend="setuptools.build_meta"
+
+[project]
+name="endfield-py"
+version="1.0.0"
+description="A Python library for fetching player data from the Enka Network API."
+authors=[
+    {name="sora", email="sahikast07@gmail.com"}
+]
+readme="README.md"
+license={file="LICENSE.txt"}
+dependencies=[
+    "aiohttp>=3.8.0",
+    "pydantic>=2.0.0",
+    "asyncio",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]

endfield_py-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

endfield_py-1.0.0/src/endfield/__init__.py

@@ -0,0 +1,3 @@
+from .client import Endfield
+
+__all__ = ["Endfield"]