foxapi 1.8.0__tar.gz → 1.9.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (181) hide show
  1. {foxapi-1.8.0 → foxapi-1.9.0}/PKG-INFO +8 -22
  2. {foxapi-1.8.0 → foxapi-1.9.0}/README.md +5 -4
  3. foxapi-1.9.0/foxapi/Images/MapIcons/36.png +0 -0
  4. foxapi-1.9.0/foxapi/Images/MapIcons/88.png +0 -0
  5. foxapi-1.9.0/foxapi/Images/MapIcons/89.png +0 -0
  6. foxapi-1.9.0/foxapi/Images/MapIcons/90.png +0 -0
  7. foxapi-1.9.0/foxapi/Images/MapIcons/91.png +0 -0
  8. foxapi-1.9.0/foxapi/Images/MapIcons/92.png +0 -0
  9. foxapi-1.9.0/foxapi/Images/MapIcons/MapIconHomeBaseHallColonial.png +0 -0
  10. foxapi-1.9.0/foxapi/Images/MapIcons/MapIconHomeBaseHallWarden.png +0 -0
  11. foxapi-1.9.0/foxapi/Images/MapsHex/FoxholeFestivalMapHex.png +0 -0
  12. foxapi-1.9.0/foxapi/Images/MapsHex/MapAcrithiaHex.png +0 -0
  13. foxapi-1.9.0/foxapi/Images/MapsHex/MapAllodsBightHex.png +0 -0
  14. foxapi-1.9.0/foxapi/Images/MapsHex/MapAshFieldsHex.png +0 -0
  15. foxapi-1.9.0/foxapi/Images/MapsHex/MapBasinSionnachHex.png +0 -0
  16. foxapi-1.9.0/foxapi/Images/MapsHex/MapCallahansPassageHex.png +0 -0
  17. foxapi-1.9.0/foxapi/Images/MapsHex/MapCallumsCapeHex.png +0 -0
  18. foxapi-1.9.0/foxapi/Images/MapsHex/MapClahstraHex.png +0 -0
  19. foxapi-1.9.0/foxapi/Images/MapsHex/MapClansheadValleyHex.png +0 -0
  20. foxapi-1.9.0/foxapi/Images/MapsHex/MapDeadLandsHex.png +0 -0
  21. foxapi-1.9.0/foxapi/Images/MapsHex/MapDrownedValeHex.png +0 -0
  22. foxapi-1.9.0/foxapi/Images/MapsHex/MapEndlessShoreHex.png +0 -0
  23. foxapi-1.9.0/foxapi/Images/MapsHex/MapFarranacCoastHex.png +0 -0
  24. foxapi-1.9.0/foxapi/Images/MapsHex/MapFishermansRowHex.png +0 -0
  25. foxapi-1.9.0/foxapi/Images/MapsHex/MapGodcroftsHex.png +0 -0
  26. foxapi-1.9.0/foxapi/Images/MapsHex/MapGreatMarchHex.png +0 -0
  27. foxapi-1.9.0/foxapi/Images/MapsHex/MapGutterHex.png +0 -0
  28. foxapi-1.9.0/foxapi/Images/MapsHex/MapHeartlandsHex.png +0 -0
  29. foxapi-1.9.0/foxapi/Images/MapsHex/MapHomeRegionC.png +0 -0
  30. foxapi-1.9.0/foxapi/Images/MapsHex/MapHomeRegionW.png +0 -0
  31. foxapi-1.9.0/foxapi/Images/MapsHex/MapHowlCountyHex.png +0 -0
  32. foxapi-1.9.0/foxapi/Images/MapsHex/MapKalokaiHex.png +0 -0
  33. foxapi-1.9.0/foxapi/Images/MapsHex/MapKingsCageHex.png +0 -0
  34. foxapi-1.9.0/foxapi/Images/MapsHex/MapKuuraStrandHex.png +0 -0
  35. foxapi-1.9.0/foxapi/Images/MapsHex/MapLinnMercyHex.png +0 -0
  36. foxapi-1.9.0/foxapi/Images/MapsHex/MapLochMorHex.png +0 -0
  37. foxapi-1.9.0/foxapi/Images/MapsHex/MapLykosIsleHex.png +0 -0
  38. foxapi-1.9.0/foxapi/Images/MapsHex/MapMarbanHollowHex.png +0 -0
  39. foxapi-1.9.0/foxapi/Images/MapsHex/MapMooringCountyHex.png +0 -0
  40. foxapi-1.9.0/foxapi/Images/MapsHex/MapMorgensCrossingHex.png +0 -0
  41. foxapi-1.9.0/foxapi/Images/MapsHex/MapNevishLineHex.png +0 -0
  42. foxapi-1.9.0/foxapi/Images/MapsHex/MapOarbreakerHex.png +0 -0
  43. foxapi-1.9.0/foxapi/Images/MapsHex/MapOlavisWakeHex.png +0 -0
  44. foxapi-1.9.0/foxapi/Images/MapsHex/MapOnyxHex.png +0 -0
  45. foxapi-1.9.0/foxapi/Images/MapsHex/MapOriginHex.png +0 -0
  46. foxapi-1.9.0/foxapi/Images/MapsHex/MapPalantineBermHex.png +0 -0
  47. foxapi-1.9.0/foxapi/Images/MapsHex/MapPariPeakHex.png +0 -0
  48. foxapi-1.9.0/foxapi/Images/MapsHex/MapPipersEnclaveHex.png +0 -0
  49. foxapi-1.9.0/foxapi/Images/MapsHex/MapReachingTrailHex.png +0 -0
  50. foxapi-1.9.0/foxapi/Images/MapsHex/MapReaversPassHex.png +0 -0
  51. foxapi-1.9.0/foxapi/Images/MapsHex/MapRedRiverHex.png +0 -0
  52. foxapi-1.9.0/foxapi/Images/MapsHex/MapSableportHex.png +0 -0
  53. foxapi-1.9.0/foxapi/Images/MapsHex/MapShackledChasmHex.png +0 -0
  54. foxapi-1.9.0/foxapi/Images/MapsHex/MapSpeakingWoodsHex.png +0 -0
  55. foxapi-1.9.0/foxapi/Images/MapsHex/MapStemaLandingHex.png +0 -0
  56. foxapi-1.9.0/foxapi/Images/MapsHex/MapStlicanShelfHex.png +0 -0
  57. foxapi-1.9.0/foxapi/Images/MapsHex/MapStonecradleHex.png +0 -0
  58. foxapi-1.9.0/foxapi/Images/MapsHex/MapTempestIslandHex.png +0 -0
  59. foxapi-1.9.0/foxapi/Images/MapsHex/MapTerminusHex.png +0 -0
  60. foxapi-1.9.0/foxapi/Images/MapsHex/MapTheFingersHex.png +0 -0
  61. foxapi-1.9.0/foxapi/Images/MapsHex/MapTyrantFoothillsHex.png +0 -0
  62. foxapi-1.9.0/foxapi/Images/MapsHex/MapUmbralWildwoodHex.png +0 -0
  63. foxapi-1.9.0/foxapi/Images/MapsHex/MapViperPitHex.png +0 -0
  64. foxapi-1.9.0/foxapi/Images/MapsHex/MapWeatheredExpanseHex.png +0 -0
  65. foxapi-1.9.0/foxapi/Images/MapsHex/MapWestgateHex.png +0 -0
  66. foxapi-1.9.0/foxapi/Images/MapsHex/MapWrestaHex.png +0 -0
  67. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/__init__.py +2 -2
  68. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/foxapi.py +19 -19
  69. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/utils.py +15 -3
  70. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi.egg-info/PKG-INFO +8 -22
  71. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi.egg-info/SOURCES.txt +21 -4
  72. {foxapi-1.8.0 → foxapi-1.9.0}/setup.py +2 -1
  73. foxapi-1.8.0/foxapi/Images/MapIcons/MapIconFortCursed.png +0 -0
  74. foxapi-1.8.0/foxapi/Images/MapIcons/MapIconForwardBase1.png +0 -0
  75. foxapi-1.8.0/foxapi/Images/MapsHex/MapAcrithiaHex.png +0 -0
  76. foxapi-1.8.0/foxapi/Images/MapsHex/MapAllodsBightHex.png +0 -0
  77. foxapi-1.8.0/foxapi/Images/MapsHex/MapAshFieldsHex.png +0 -0
  78. foxapi-1.8.0/foxapi/Images/MapsHex/MapBasinSionnachHex.png +0 -0
  79. foxapi-1.8.0/foxapi/Images/MapsHex/MapCallahansPassageHex.png +0 -0
  80. foxapi-1.8.0/foxapi/Images/MapsHex/MapCallumsCapeHex.png +0 -0
  81. foxapi-1.8.0/foxapi/Images/MapsHex/MapClahstraHex.png +0 -0
  82. foxapi-1.8.0/foxapi/Images/MapsHex/MapClansheadValleyHex.png +0 -0
  83. foxapi-1.8.0/foxapi/Images/MapsHex/MapDeadLandsHex.png +0 -0
  84. foxapi-1.8.0/foxapi/Images/MapsHex/MapDrownedValeHex.png +0 -0
  85. foxapi-1.8.0/foxapi/Images/MapsHex/MapEndlessShoreHex.png +0 -0
  86. foxapi-1.8.0/foxapi/Images/MapsHex/MapFarranacCoastHex.png +0 -0
  87. foxapi-1.8.0/foxapi/Images/MapsHex/MapFishermansRowHex.png +0 -0
  88. foxapi-1.8.0/foxapi/Images/MapsHex/MapGodcroftsHex.png +0 -0
  89. foxapi-1.8.0/foxapi/Images/MapsHex/MapGreatMarchHex.png +0 -0
  90. foxapi-1.8.0/foxapi/Images/MapsHex/MapHeartlandsHex.png +0 -0
  91. foxapi-1.8.0/foxapi/Images/MapsHex/MapHomeRegionC.png +0 -0
  92. foxapi-1.8.0/foxapi/Images/MapsHex/MapHomeRegionW.png +0 -0
  93. foxapi-1.8.0/foxapi/Images/MapsHex/MapHowlCountyHex.png +0 -0
  94. foxapi-1.8.0/foxapi/Images/MapsHex/MapKalokaiHex.png +0 -0
  95. foxapi-1.8.0/foxapi/Images/MapsHex/MapKingsCageHex.png +0 -0
  96. foxapi-1.8.0/foxapi/Images/MapsHex/MapLinnMercyHex.png +0 -0
  97. foxapi-1.8.0/foxapi/Images/MapsHex/MapLochMorHex.png +0 -0
  98. foxapi-1.8.0/foxapi/Images/MapsHex/MapMarbanHollow.png +0 -0
  99. foxapi-1.8.0/foxapi/Images/MapsHex/MapMooringCountyHex.png +0 -0
  100. foxapi-1.8.0/foxapi/Images/MapsHex/MapMorgensCrossingHex.png +0 -0
  101. foxapi-1.8.0/foxapi/Images/MapsHex/MapNevishLineHex.png +0 -0
  102. foxapi-1.8.0/foxapi/Images/MapsHex/MapOarbreakerHex.png +0 -0
  103. foxapi-1.8.0/foxapi/Images/MapsHex/MapOriginHex.png +0 -0
  104. foxapi-1.8.0/foxapi/Images/MapsHex/MapReachingTrailHex.png +0 -0
  105. foxapi-1.8.0/foxapi/Images/MapsHex/MapReaversPassHex.png +0 -0
  106. foxapi-1.8.0/foxapi/Images/MapsHex/MapRedRiverHex.png +0 -0
  107. foxapi-1.8.0/foxapi/Images/MapsHex/MapSableportHex.png +0 -0
  108. foxapi-1.8.0/foxapi/Images/MapsHex/MapShackledChasmHex.png +0 -0
  109. foxapi-1.8.0/foxapi/Images/MapsHex/MapSpeakingWoodsHex.png +0 -0
  110. foxapi-1.8.0/foxapi/Images/MapsHex/MapStemaLandingHex.png +0 -0
  111. foxapi-1.8.0/foxapi/Images/MapsHex/MapStlicanShelfHex.png +0 -0
  112. foxapi-1.8.0/foxapi/Images/MapsHex/MapStonecradleHex.png +0 -0
  113. foxapi-1.8.0/foxapi/Images/MapsHex/MapTempestIslandHex.png +0 -0
  114. foxapi-1.8.0/foxapi/Images/MapsHex/MapTerminusHex.png +0 -0
  115. foxapi-1.8.0/foxapi/Images/MapsHex/MapTheFingersHex.png +0 -0
  116. foxapi-1.8.0/foxapi/Images/MapsHex/MapUmbralWildwoodHex.png +0 -0
  117. foxapi-1.8.0/foxapi/Images/MapsHex/MapViperPitHex.png +0 -0
  118. foxapi-1.8.0/foxapi/Images/MapsHex/MapWeatheredExpanseHex.png +0 -0
  119. foxapi-1.8.0/foxapi/Images/MapsHex/MapWestgateHex.png +0 -0
  120. {foxapi-1.8.0 → foxapi-1.9.0}/LICENSE +0 -0
  121. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/10.png +0 -0
  122. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/11.png +0 -0
  123. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/12.png +0 -0
  124. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/13.png +0 -0
  125. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/14.png +0 -0
  126. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/15.png +0 -0
  127. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/16.png +0 -0
  128. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/17.png +0 -0
  129. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/18.png +0 -0
  130. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/19.png +0 -0
  131. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/20.png +0 -0
  132. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/21.png +0 -0
  133. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/22.png +0 -0
  134. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/23.png +0 -0
  135. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/27.png +0 -0
  136. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/28.png +0 -0
  137. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/29.png +0 -0
  138. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/30.png +0 -0
  139. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/32.png +0 -0
  140. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/33.png +0 -0
  141. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/34.png +0 -0
  142. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/35.png +0 -0
  143. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/37.png +0 -0
  144. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/38.png +0 -0
  145. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/39.png +0 -0
  146. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/40.png +0 -0
  147. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/41.png +0 -0
  148. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/45.png +0 -0
  149. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/46.png +0 -0
  150. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/47.png +0 -0
  151. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/5.png +0 -0
  152. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/51.png +0 -0
  153. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/52.png +0 -0
  154. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/53.png +0 -0
  155. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/54.png +0 -0
  156. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/56.png +0 -0
  157. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/57.png +0 -0
  158. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/58.png +0 -0
  159. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/59.png +0 -0
  160. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/6.png +0 -0
  161. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/60.png +0 -0
  162. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/61.png +0 -0
  163. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/62.png +0 -0
  164. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/7.png +0 -0
  165. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/70.png +0 -0
  166. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/71.png +0 -0
  167. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/72.png +0 -0
  168. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/75.png +0 -0
  169. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/8.png +0 -0
  170. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/83.png +0 -0
  171. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/84.png +0 -0
  172. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/9.png +0 -0
  173. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/DebugIcon.png +0 -0
  174. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/MapIconCivicCenter.png +0 -0
  175. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/MapIconScorchedTown.png +0 -0
  176. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/MapIconTownHall.png +0 -0
  177. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi/Images/MapIcons/MapIconVictory.png +0 -0
  178. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi.egg-info/dependency_links.txt +0 -0
  179. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi.egg-info/requires.txt +0 -0
  180. {foxapi-1.8.0 → foxapi-1.9.0}/foxapi.egg-info/top_level.txt +0 -0
  181. {foxapi-1.8.0 → foxapi-1.9.0}/setup.cfg +0 -0
@@ -1,33 +1,18 @@
1
- Metadata-Version: 2.4
1
+ Metadata-Version: 2.1
2
2
  Name: foxapi
3
- Version: 1.8.0
3
+ Version: 1.9.0
4
4
  Summary: A wrapper for the foxhole API
5
5
  Home-page: https://github.com/ThePhoenix78/FoxAPI
6
6
  Download-URL: https://github.com/ThePhoenix78/FoxAPI/tarball/master
7
7
  Author: ThePhoenix78
8
8
  Author-email: thephoenix788@gmail.com
9
9
  License: MIT
10
- Keywords: foxhole,foxapi,foxhole-game,foxhole-api
10
+ Keywords: foxhole,foxapi,foxhole-game,foxhole-api,warapi
11
11
  Classifier: Programming Language :: Python :: 3
12
12
  Classifier: License :: OSI Approved :: MIT License
13
13
  Classifier: Operating System :: OS Independent
14
14
  Description-Content-Type: text/markdown
15
15
  License-File: LICENSE
16
- Requires-Dist: requests
17
- Requires-Dist: pillow
18
- Requires-Dist: aiohttp
19
- Dynamic: author
20
- Dynamic: author-email
21
- Dynamic: classifier
22
- Dynamic: description
23
- Dynamic: description-content-type
24
- Dynamic: download-url
25
- Dynamic: home-page
26
- Dynamic: keywords
27
- Dynamic: license
28
- Dynamic: license-file
29
- Dynamic: requires-dist
30
- Dynamic: summary
31
16
 
32
17
  # FoxAPI Documentation
33
18
 
@@ -86,12 +71,13 @@ class FoxAPI(shard: str = "", image_dir: str = None, safe_mode: bool = True)
86
71
  #### Note : all of theses methods are async, to run the synchronous version, add _sync at the end (see API example)
87
72
 
88
73
  ```py
89
- get_data(endpoint: str, etag: str = None, use_cache: bool = False) -> APIResponse
74
+ get_data(endpoint: str, session: aiohttp.ClientSession | None = None, etag: str = None, use_cache: bool = False) -> APIResponse
90
75
  ```
91
76
  Fetches data from the specified endpoint, you can choose to use cache instead of sending a request and you can pass ETag.
92
77
 
93
78
  - Parameters:
94
79
  - `endpoint` (str): The API endpoint to call.
80
+ - `session` (aiohttp.ClientSession, optional) the async session
95
81
  - `etag` (str, optional): The ETag header for cache validation (not required since managed natively).
96
82
  - `use_cache` (bool, optional): Whether to use cached data (default: False).
97
83
 
@@ -140,7 +126,7 @@ calc_distance(x1: float, y1: float, x2: float, y2: float) -> float
140
126
  - Calculates the Euclidean distance between two points on the map.
141
127
 
142
128
  ```py
143
- get_captured_towns(hexagon: str = None, dynamic: dict = None, static: dict = None) -> dict
129
+ get_captured_towns(hexagon: str = None, dynamic: dict = None, static: dict = None, session: aiohttp.ClientSession | None = None) -> dict
144
130
  ```
145
131
  - Retrieves the captured towns for a given hexagon based on dynamic and static data.
146
132
 
@@ -151,14 +137,14 @@ load_hexagon_map(hexagon: str) -> pillow.Image
151
137
  - Loads the PNG map for the specified hexagon.
152
138
 
153
139
  ```py
154
- make_map_png(hexagon: str, icons: str | list = "all", colored: bool = False, dynamic: dict = None, static: dict = None) -> pillow.Image
140
+ make_map_png(hexagon: str, icons: str | list = "all", colored: bool = False, dynamic: dict = None, static: dict = None, session: aiohttp.ClientSession | None = None) -> pillow.Image
155
141
  ```
156
142
  - Generates a PNG image of the hexagon map with all the icons associated to each faction in their respective colors (included fields and town base). Only public data will be present.
157
143
  - colored -> display each region in the team's color
158
144
  - icons -> display selected building in their team's color
159
145
 
160
146
  ```py
161
- calculate_death_rate(hexagon: str = None, war_report: dict = None): -> dict
147
+ calculate_death_rate(hexagon: str = None, war_report: dict = None, session: aiohttp.ClientSession | None = None): -> dict
162
148
  ```
163
149
  - calculate the death rate between the first launch and the current one
164
150
 
@@ -55,12 +55,13 @@ class FoxAPI(shard: str = "", image_dir: str = None, safe_mode: bool = True)
55
55
  #### Note : all of theses methods are async, to run the synchronous version, add _sync at the end (see API example)
56
56
 
57
57
  ```py
58
- get_data(endpoint: str, etag: str = None, use_cache: bool = False) -> APIResponse
58
+ get_data(endpoint: str, session: aiohttp.ClientSession | None = None, etag: str = None, use_cache: bool = False) -> APIResponse
59
59
  ```
60
60
  Fetches data from the specified endpoint, you can choose to use cache instead of sending a request and you can pass ETag.
61
61
 
62
62
  - Parameters:
63
63
  - `endpoint` (str): The API endpoint to call.
64
+ - `session` (aiohttp.ClientSession, optional) the async session
64
65
  - `etag` (str, optional): The ETag header for cache validation (not required since managed natively).
65
66
  - `use_cache` (bool, optional): Whether to use cached data (default: False).
66
67
 
@@ -109,7 +110,7 @@ calc_distance(x1: float, y1: float, x2: float, y2: float) -> float
109
110
  - Calculates the Euclidean distance between two points on the map.
110
111
 
111
112
  ```py
112
- get_captured_towns(hexagon: str = None, dynamic: dict = None, static: dict = None) -> dict
113
+ get_captured_towns(hexagon: str = None, dynamic: dict = None, static: dict = None, session: aiohttp.ClientSession | None = None) -> dict
113
114
  ```
114
115
  - Retrieves the captured towns for a given hexagon based on dynamic and static data.
115
116
 
@@ -120,14 +121,14 @@ load_hexagon_map(hexagon: str) -> pillow.Image
120
121
  - Loads the PNG map for the specified hexagon.
121
122
 
122
123
  ```py
123
- make_map_png(hexagon: str, icons: str | list = "all", colored: bool = False, dynamic: dict = None, static: dict = None) -> pillow.Image
124
+ make_map_png(hexagon: str, icons: str | list = "all", colored: bool = False, dynamic: dict = None, static: dict = None, session: aiohttp.ClientSession | None = None) -> pillow.Image
124
125
  ```
125
126
  - Generates a PNG image of the hexagon map with all the icons associated to each faction in their respective colors (included fields and town base). Only public data will be present.
126
127
  - colored -> display each region in the team's color
127
128
  - icons -> display selected building in their team's color
128
129
 
129
130
  ```py
130
- calculate_death_rate(hexagon: str = None, war_report: dict = None): -> dict
131
+ calculate_death_rate(hexagon: str = None, war_report: dict = None, session: aiohttp.ClientSession | None = None): -> dict
131
132
  ```
132
133
  - calculate the death rate between the first launch and the current one
133
134
 
@@ -1,5 +1,5 @@
1
1
  from .foxapi import FoxAPI
2
- from .utils import HexagonObject, FoxAPIError, HexagonError, EndpointError, APIResponse, Task
2
+ from .utils import HexagonObject, FoxAPIError, HexagonError, EndpointError, APIResponse, Task, _images_relations, _map_flags
3
3
 
4
4
  import requests, json
5
5
 
@@ -9,7 +9,7 @@ __author__ = 'ThePhoenix78'
9
9
  __license__ = 'MIT'
10
10
  __copyright__ = 'Copyright 2024-2026 ThePhoenix78'
11
11
  __url__ = 'https://github.com/ThePhoenix78/FoxAPI'
12
- __newest__ = __version__ = '1.8.0'
12
+ __newest__ = __version__ = '1.9.0'
13
13
 
14
14
 
15
15
  try:
@@ -360,29 +360,29 @@ class FoxAPI():
360
360
  ---------------------------------------- ASYNC METHODS ----------------------------------------
361
361
  """
362
362
 
363
- async def get_maps(self, use_cache: bool = True, session: aiohttp.ClientSession = None):
363
+ async def get_maps(self, use_cache: bool = True, session: aiohttp.ClientSession | None = None):
364
364
  data: APIResponse = await self.get_data(endpoint="/maps", use_cache=use_cache, session=session)
365
365
  return data.json
366
366
 
367
- async def get_war(self, use_cache: bool = None, session: aiohttp.ClientSession = None):
367
+ async def get_war(self, use_cache: bool = None, session: aiohttp.ClientSession | None = None):
368
368
  data: APIResponse = await self.get_data(endpoint="/war", use_cache=use_cache, session=session)
369
369
  return data.json
370
370
 
371
- async def get_static(self, hexagon: str, use_cache: bool = True, session: aiohttp.ClientSession = None):
371
+ async def get_static(self, hexagon: str, use_cache: bool = True, session: aiohttp.ClientSession | None = None):
372
372
  if self._safe_mode:
373
373
  hexagon: str = self._format_hexagon(hexagon)
374
374
 
375
375
  data: APIResponse = await self.get_data(endpoint=f"/maps/{hexagon}/static", use_cache=use_cache, session=session)
376
376
  return data.json
377
377
 
378
- async def get_dynamic(self, hexagon: str, use_cache: bool = None, session: aiohttp.ClientSession = None):
378
+ async def get_dynamic(self, hexagon: str, use_cache: bool = None, session: aiohttp.ClientSession | None = None):
379
379
  if self._safe_mode:
380
380
  hexagon: str = self._format_hexagon(hexagon)
381
381
 
382
382
  data: APIResponse = await self.get_data(endpoint=f"/maps/{hexagon}/dynamic/public", use_cache=use_cache, session=session)
383
383
  return data.json
384
384
 
385
- async def get_war_report(self, hexagon: str, use_cache: bool = None, session: aiohttp.ClientSession = None):
385
+ async def get_war_report(self, hexagon: str, use_cache: bool = None, session: aiohttp.ClientSession | None = None):
386
386
  if self._safe_mode:
387
387
  hexagon: str = self._format_hexagon(hexagon)
388
388
 
@@ -393,22 +393,22 @@ class FoxAPI():
393
393
  ---------------------------------------- ADDITIONAL ASYNC METHODS ----------------------------------------
394
394
  """
395
395
 
396
- async def get_captured_towns(self, hexagon: str = None, dynamic: dict = None, static: dict = None) -> dict[str, str]:
396
+ async def get_captured_towns(self, hexagon: str = None, dynamic: dict = None, static: dict = None, session: aiohttp.ClientSession | None = None) -> dict[str, str]:
397
397
  if hexagon is not None and static is None and dynamic is None:
398
- static: dict = await self.get_static(hexagon, use_cache=True)
399
- dynamic: dict = await self.get_dynamic(hexagon)
398
+ static: dict = await self.get_static(hexagon, use_cache=True, session=session)
399
+ dynamic: dict = await self.get_dynamic(hexagon, session=session)
400
400
 
401
401
  if static is None or dynamic is None:
402
402
  raise FoxAPIError("Please pass the required parameters (hexagon or (static and dynamic))")
403
403
 
404
404
  return self.associate_towns(dynamic=dynamic, static=static)
405
405
 
406
- async def make_map_png(self, hexagon: str, icons: str | list[int | str] = "all", colored: bool = False, dynamic: dict = None, static: dict = None):
406
+ async def make_map_png(self, hexagon: str, icons: str | list[int | str] = "all", colored: bool = False, dynamic: dict = None, static: dict = None, session: aiohttp.ClientSession | None = None):
407
407
  if dynamic is None and (icons or colored):
408
- dynamic: dict = await self.get_dynamic(hexagon=hexagon)
408
+ dynamic: dict = await self.get_dynamic(hexagon=hexagon, session=session)
409
409
 
410
410
  if static is None and colored:
411
- static: dict = await self.get_static(hexagon=hexagon, use_cache=True)
411
+ static: dict = await self.get_static(hexagon=hexagon, use_cache=True, session=session)
412
412
 
413
413
  img1: Image = self.load_hexagon_map(hexagon)
414
414
 
@@ -420,28 +420,28 @@ class FoxAPI():
420
420
 
421
421
  return img1
422
422
 
423
- async def calculate_death_rate(self, hexagon: str = None, war_report: dict = None):
423
+ async def calculate_death_rate(self, hexagon: str = None, war_report: dict = None, session: aiohttp.ClientSession | None = None):
424
424
  if self._safe_mode:
425
425
  hexagon: str = self._format_hexagon(hexagon=hexagon)
426
426
 
427
427
  if war_report is None:
428
- war_report: dict = await self.get_war_report(hexagon)
428
+ war_report: dict = await self.get_war_report(hexagon, session=session)
429
429
 
430
430
  if war_report is None:
431
431
  raise FoxAPIError("Please pass the required parameters (hexagon or war_report)")
432
432
 
433
433
  return self._calc_death_rate(hexagon=hexagon, war_report=war_report)
434
434
 
435
- async def get_hexagon_data(self, hexagon: str, use_cache: bool = None):
435
+ async def get_hexagon_data(self, hexagon: str, use_cache: bool = None, session: aiohttp.ClientSession | None = None):
436
436
  if self._safe_mode:
437
437
  hexagon: str = self._format_hexagon(hexagon=hexagon)
438
438
 
439
- war_report: dict = await self.get_war_report(hexagon=hexagon, use_cache=use_cache)
440
- static: dict = await self.get_static(hexagon=hexagon, use_cache=True)
441
- dynamic: dict = await self.get_dynamic(hexagon=hexagon, use_cache=use_cache)
439
+ war_report: dict = await self.get_war_report(hexagon=hexagon, use_cache=use_cache, session=session)
440
+ static: dict = await self.get_static(hexagon=hexagon, use_cache=True, session=session)
441
+ dynamic: dict = await self.get_dynamic(hexagon=hexagon, use_cache=use_cache, session=session)
442
442
 
443
- captured_towns: dict = await self.get_captured_towns(dynamic=dynamic, static=static)
444
- casualty_rate: dict = await self.calculate_death_rate(hexagon=hexagon, war_report=war_report)
443
+ captured_towns: dict = await self.get_captured_towns(dynamic=dynamic, static=static, session=session)
444
+ casualty_rate: dict = await self.calculate_death_rate(hexagon=hexagon, war_report=war_report, session=session)
445
445
 
446
446
  return HexagonObject(hexagon=hexagon, war_report=war_report, static=static, dynamic=dynamic, captured_towns=captured_towns, casualty_rate=casualty_rate)
447
447
 
@@ -55,7 +55,20 @@ _images_relations: dict = {
55
55
  "72": "RocketSiteWithRocket",
56
56
  "75": "FacilityMineOilRig",
57
57
  "83": "WeatherStation",
58
- "84": "MortarHouse"
58
+ "84": "MortarHouse",
59
+ "88": "AircraftDepot",
60
+ "89": "AircraftFactory",
61
+ "90": "AircraftRadar",
62
+ "91": "AircraftRunwayT1",
63
+ "92": "AircraftRunwayT2"
64
+ }
65
+
66
+ _map_flags: dict = {
67
+ "0x01": "IsVictoryBase",
68
+ "0x02": "IsHomeBase",
69
+ "0x04": "IsBuildSite",
70
+ "0x10": "IsScorched",
71
+ "0x20": "IsTownClaimed"
59
72
  }
60
73
 
61
74
  class EndpointError(Exception):
@@ -95,7 +108,7 @@ class HexagonObject:
95
108
  self.captured_towns: dict = captured_towns
96
109
  self.casualty_rate: dict = casualty_rate
97
110
 
98
- '''
111
+
99
112
  class FoxObject:
100
113
  """
101
114
  Universal wrapper for any kind of dict item
@@ -140,4 +153,3 @@ class APIObject:
140
153
 
141
154
  def items(self):
142
155
  return self.json.__dict__.items()
143
- '''
@@ -1,33 +1,18 @@
1
- Metadata-Version: 2.4
1
+ Metadata-Version: 2.1
2
2
  Name: foxapi
3
- Version: 1.8.0
3
+ Version: 1.9.0
4
4
  Summary: A wrapper for the foxhole API
5
5
  Home-page: https://github.com/ThePhoenix78/FoxAPI
6
6
  Download-URL: https://github.com/ThePhoenix78/FoxAPI/tarball/master
7
7
  Author: ThePhoenix78
8
8
  Author-email: thephoenix788@gmail.com
9
9
  License: MIT
10
- Keywords: foxhole,foxapi,foxhole-game,foxhole-api
10
+ Keywords: foxhole,foxapi,foxhole-game,foxhole-api,warapi
11
11
  Classifier: Programming Language :: Python :: 3
12
12
  Classifier: License :: OSI Approved :: MIT License
13
13
  Classifier: Operating System :: OS Independent
14
14
  Description-Content-Type: text/markdown
15
15
  License-File: LICENSE
16
- Requires-Dist: requests
17
- Requires-Dist: pillow
18
- Requires-Dist: aiohttp
19
- Dynamic: author
20
- Dynamic: author-email
21
- Dynamic: classifier
22
- Dynamic: description
23
- Dynamic: description-content-type
24
- Dynamic: download-url
25
- Dynamic: home-page
26
- Dynamic: keywords
27
- Dynamic: license
28
- Dynamic: license-file
29
- Dynamic: requires-dist
30
- Dynamic: summary
31
16
 
32
17
  # FoxAPI Documentation
33
18
 
@@ -86,12 +71,13 @@ class FoxAPI(shard: str = "", image_dir: str = None, safe_mode: bool = True)
86
71
  #### Note : all of theses methods are async, to run the synchronous version, add _sync at the end (see API example)
87
72
 
88
73
  ```py
89
- get_data(endpoint: str, etag: str = None, use_cache: bool = False) -> APIResponse
74
+ get_data(endpoint: str, session: aiohttp.ClientSession | None = None, etag: str = None, use_cache: bool = False) -> APIResponse
90
75
  ```
91
76
  Fetches data from the specified endpoint, you can choose to use cache instead of sending a request and you can pass ETag.
92
77
 
93
78
  - Parameters:
94
79
  - `endpoint` (str): The API endpoint to call.
80
+ - `session` (aiohttp.ClientSession, optional) the async session
95
81
  - `etag` (str, optional): The ETag header for cache validation (not required since managed natively).
96
82
  - `use_cache` (bool, optional): Whether to use cached data (default: False).
97
83
 
@@ -140,7 +126,7 @@ calc_distance(x1: float, y1: float, x2: float, y2: float) -> float
140
126
  - Calculates the Euclidean distance between two points on the map.
141
127
 
142
128
  ```py
143
- get_captured_towns(hexagon: str = None, dynamic: dict = None, static: dict = None) -> dict
129
+ get_captured_towns(hexagon: str = None, dynamic: dict = None, static: dict = None, session: aiohttp.ClientSession | None = None) -> dict
144
130
  ```
145
131
  - Retrieves the captured towns for a given hexagon based on dynamic and static data.
146
132
 
@@ -151,14 +137,14 @@ load_hexagon_map(hexagon: str) -> pillow.Image
151
137
  - Loads the PNG map for the specified hexagon.
152
138
 
153
139
  ```py
154
- make_map_png(hexagon: str, icons: str | list = "all", colored: bool = False, dynamic: dict = None, static: dict = None) -> pillow.Image
140
+ make_map_png(hexagon: str, icons: str | list = "all", colored: bool = False, dynamic: dict = None, static: dict = None, session: aiohttp.ClientSession | None = None) -> pillow.Image
155
141
  ```
156
142
  - Generates a PNG image of the hexagon map with all the icons associated to each faction in their respective colors (included fields and town base). Only public data will be present.
157
143
  - colored -> display each region in the team's color
158
144
  - icons -> display selected building in their team's color
159
145
 
160
146
  ```py
161
- calculate_death_rate(hexagon: str = None, war_report: dict = None): -> dict
147
+ calculate_death_rate(hexagon: str = None, war_report: dict = None, session: aiohttp.ClientSession | None = None): -> dict
162
148
  ```
163
149
  - calculate the death rate between the first launch and the current one
164
150
 
@@ -31,6 +31,7 @@ foxapi/Images/MapIcons/32.png
31
31
  foxapi/Images/MapIcons/33.png
32
32
  foxapi/Images/MapIcons/34.png
33
33
  foxapi/Images/MapIcons/35.png
34
+ foxapi/Images/MapIcons/36.png
34
35
  foxapi/Images/MapIcons/37.png
35
36
  foxapi/Images/MapIcons/38.png
36
37
  foxapi/Images/MapIcons/39.png
@@ -60,14 +61,20 @@ foxapi/Images/MapIcons/75.png
60
61
  foxapi/Images/MapIcons/8.png
61
62
  foxapi/Images/MapIcons/83.png
62
63
  foxapi/Images/MapIcons/84.png
64
+ foxapi/Images/MapIcons/88.png
65
+ foxapi/Images/MapIcons/89.png
63
66
  foxapi/Images/MapIcons/9.png
67
+ foxapi/Images/MapIcons/90.png
68
+ foxapi/Images/MapIcons/91.png
69
+ foxapi/Images/MapIcons/92.png
64
70
  foxapi/Images/MapIcons/DebugIcon.png
65
71
  foxapi/Images/MapIcons/MapIconCivicCenter.png
66
- foxapi/Images/MapIcons/MapIconFortCursed.png
67
- foxapi/Images/MapIcons/MapIconForwardBase1.png
72
+ foxapi/Images/MapIcons/MapIconHomeBaseHallColonial.png
73
+ foxapi/Images/MapIcons/MapIconHomeBaseHallWarden.png
68
74
  foxapi/Images/MapIcons/MapIconScorchedTown.png
69
75
  foxapi/Images/MapIcons/MapIconTownHall.png
70
76
  foxapi/Images/MapIcons/MapIconVictory.png
77
+ foxapi/Images/MapsHex/FoxholeFestivalMapHex.png
71
78
  foxapi/Images/MapsHex/MapAcrithiaHex.png
72
79
  foxapi/Images/MapsHex/MapAllodsBightHex.png
73
80
  foxapi/Images/MapsHex/MapAshFieldsHex.png
@@ -83,20 +90,28 @@ foxapi/Images/MapsHex/MapFarranacCoastHex.png
83
90
  foxapi/Images/MapsHex/MapFishermansRowHex.png
84
91
  foxapi/Images/MapsHex/MapGodcroftsHex.png
85
92
  foxapi/Images/MapsHex/MapGreatMarchHex.png
93
+ foxapi/Images/MapsHex/MapGutterHex.png
86
94
  foxapi/Images/MapsHex/MapHeartlandsHex.png
87
95
  foxapi/Images/MapsHex/MapHomeRegionC.png
88
96
  foxapi/Images/MapsHex/MapHomeRegionW.png
89
97
  foxapi/Images/MapsHex/MapHowlCountyHex.png
90
98
  foxapi/Images/MapsHex/MapKalokaiHex.png
91
99
  foxapi/Images/MapsHex/MapKingsCageHex.png
100
+ foxapi/Images/MapsHex/MapKuuraStrandHex.png
92
101
  foxapi/Images/MapsHex/MapLinnMercyHex.png
93
102
  foxapi/Images/MapsHex/MapLochMorHex.png
94
- foxapi/Images/MapsHex/MapMarbanHollow.png
103
+ foxapi/Images/MapsHex/MapLykosIsleHex.png
104
+ foxapi/Images/MapsHex/MapMarbanHollowHex.png
95
105
  foxapi/Images/MapsHex/MapMooringCountyHex.png
96
106
  foxapi/Images/MapsHex/MapMorgensCrossingHex.png
97
107
  foxapi/Images/MapsHex/MapNevishLineHex.png
98
108
  foxapi/Images/MapsHex/MapOarbreakerHex.png
109
+ foxapi/Images/MapsHex/MapOlavisWakeHex.png
110
+ foxapi/Images/MapsHex/MapOnyxHex.png
99
111
  foxapi/Images/MapsHex/MapOriginHex.png
112
+ foxapi/Images/MapsHex/MapPalantineBermHex.png
113
+ foxapi/Images/MapsHex/MapPariPeakHex.png
114
+ foxapi/Images/MapsHex/MapPipersEnclaveHex.png
100
115
  foxapi/Images/MapsHex/MapReachingTrailHex.png
101
116
  foxapi/Images/MapsHex/MapReaversPassHex.png
102
117
  foxapi/Images/MapsHex/MapRedRiverHex.png
@@ -109,7 +124,9 @@ foxapi/Images/MapsHex/MapStonecradleHex.png
109
124
  foxapi/Images/MapsHex/MapTempestIslandHex.png
110
125
  foxapi/Images/MapsHex/MapTerminusHex.png
111
126
  foxapi/Images/MapsHex/MapTheFingersHex.png
127
+ foxapi/Images/MapsHex/MapTyrantFoothillsHex.png
112
128
  foxapi/Images/MapsHex/MapUmbralWildwoodHex.png
113
129
  foxapi/Images/MapsHex/MapViperPitHex.png
114
130
  foxapi/Images/MapsHex/MapWeatheredExpanseHex.png
115
- foxapi/Images/MapsHex/MapWestgateHex.png
131
+ foxapi/Images/MapsHex/MapWestgateHex.png
132
+ foxapi/Images/MapsHex/MapWrestaHex.png
@@ -20,7 +20,8 @@ setup(
20
20
  'foxhole',
21
21
  'foxapi',
22
22
  'foxhole-game',
23
- 'foxhole-api'
23
+ 'foxhole-api',
24
+ 'warapi'
24
25
  ],
25
26
  install_requires=[
26
27
  'requests',
File without changes
File without changes