foxapi 1.1.4__tar.gz → 1.2.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 (183) hide show
  1. {foxapi-1.1.4 → foxapi-1.2.0}/PKG-INFO +70 -44
  2. {foxapi-1.1.4 → foxapi-1.2.0}/README.md +69 -43
  3. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/foxapi.py +10 -10
  4. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi.egg-info/PKG-INFO +70 -44
  5. {foxapi-1.1.4 → foxapi-1.2.0}/setup.py +1 -2
  6. {foxapi-1.1.4 → foxapi-1.2.0}/LICENSE +0 -0
  7. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/10.png +0 -0
  8. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/11.png +0 -0
  9. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/11COLONIALS.png +0 -0
  10. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/11WARDENS.png +0 -0
  11. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/12.png +0 -0
  12. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/12COLONIALS.png +0 -0
  13. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/12WARDENS.png +0 -0
  14. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/13.png +0 -0
  15. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/14.png +0 -0
  16. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/15.png +0 -0
  17. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/16.png +0 -0
  18. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/17.png +0 -0
  19. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/17COLONIALS.png +0 -0
  20. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/17WARDENS.png +0 -0
  21. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/18.png +0 -0
  22. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/18COLONIALS.png +0 -0
  23. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/18WARDENS.png +0 -0
  24. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/19.png +0 -0
  25. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/19COLONIALS.png +0 -0
  26. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/19WARDENS.png +0 -0
  27. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/20.png +0 -0
  28. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/21.png +0 -0
  29. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/22.png +0 -0
  30. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/23.png +0 -0
  31. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/27.png +0 -0
  32. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/27COLONIALS.png +0 -0
  33. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/27WARDENS.png +0 -0
  34. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/28.png +0 -0
  35. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/28COLONIALS.png +0 -0
  36. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/28WARDENS.png +0 -0
  37. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/29.png +0 -0
  38. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/29COLONIALS.png +0 -0
  39. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/29WARDENS.png +0 -0
  40. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/30.png +0 -0
  41. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/30COLONIALS.png +0 -0
  42. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/30WARDENS.png +0 -0
  43. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/32.png +0 -0
  44. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/33.png +0 -0
  45. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/33COLONIALS.png +0 -0
  46. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/33WARDENS.png +0 -0
  47. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/34.png +0 -0
  48. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/34COLONIALS.png +0 -0
  49. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/34WARDENS.png +0 -0
  50. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/35.png +0 -0
  51. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/35COLONIALS.png +0 -0
  52. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/35WARDENS.png +0 -0
  53. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/37.png +0 -0
  54. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/37COLONIALS.png +0 -0
  55. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/37WARDENS.png +0 -0
  56. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/38.png +0 -0
  57. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/39.png +0 -0
  58. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/39COLONIALS.png +0 -0
  59. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/39WARDENS.png +0 -0
  60. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/40.png +0 -0
  61. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/41.png +0 -0
  62. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/45.png +0 -0
  63. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/45COLONIALS.png +0 -0
  64. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/45WARDENS.png +0 -0
  65. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/46.png +0 -0
  66. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/46COLONIALS.png +0 -0
  67. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/46WARDENS.png +0 -0
  68. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/47.png +0 -0
  69. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/47COLONIALS.png +0 -0
  70. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/47WARDENS.png +0 -0
  71. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/5.png +0 -0
  72. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/51.png +0 -0
  73. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/51COLONIALS.png +0 -0
  74. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/51WARDENS.png +0 -0
  75. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/52.png +0 -0
  76. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/52COLONIALS.png +0 -0
  77. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/52WARDENS.png +0 -0
  78. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/53.png +0 -0
  79. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/53COLONIALS.png +0 -0
  80. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/53WARDENS.png +0 -0
  81. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/54.png +0 -0
  82. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/56.png +0 -0
  83. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/56COLONIALS.png +0 -0
  84. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/56WARDENS.png +0 -0
  85. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/57.png +0 -0
  86. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/57COLONIALS.png +0 -0
  87. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/57WARDENS.png +0 -0
  88. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/58.png +0 -0
  89. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/58COLONIALS.png +0 -0
  90. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/58WARDENS.png +0 -0
  91. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/59COLONIALS.png +0 -0
  92. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/59WARDENS.png +0 -0
  93. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/5COLONIALS.png +0 -0
  94. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/5WARDENS.png +0 -0
  95. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/6.png +0 -0
  96. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/60COLONIALS.png +0 -0
  97. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/60WARDENS.png +0 -0
  98. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/61.png +0 -0
  99. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/62.png +0 -0
  100. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/6COLONIALS.png +0 -0
  101. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/6WARDENS.png +0 -0
  102. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/7.png +0 -0
  103. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/75.png +0 -0
  104. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/75COLONIALS.png +0 -0
  105. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/75WARDENS.png +0 -0
  106. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/7COLONIALS.png +0 -0
  107. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/7WARDENS.png +0 -0
  108. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/8.png +0 -0
  109. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/84COLONIALS.png +0 -0
  110. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/84WARDENS.png +0 -0
  111. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/8COLONIALS.png +0 -0
  112. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/8WARDENS.png +0 -0
  113. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/9.png +0 -0
  114. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/9COLONIALS.png +0 -0
  115. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/9WARDENS.png +0 -0
  116. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/DebugIcon.png +0 -0
  117. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconCivicCenter.png +0 -0
  118. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconCoalFieldColor.png +0 -0
  119. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconFortCursed.png +0 -0
  120. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconHomeBaseHallColonial.png +0 -0
  121. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconHomeBaseHallWarden.png +0 -0
  122. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconOilFieldColor.png +0 -0
  123. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconSafehouse.png +0 -0
  124. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconScorchedTown.png +0 -0
  125. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconSulfurColor.png +0 -0
  126. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconTownHall.png +0 -0
  127. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconTownHallColonial.png +0 -0
  128. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconTownHallWarden.png +0 -0
  129. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconVictory.png +0 -0
  130. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconVictoryColonial.png +0 -0
  131. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapIcons/MapIconVictoryWarden.png +0 -0
  132. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapAcrithiaHex.png +0 -0
  133. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapAllodsBightHex.png +0 -0
  134. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapAshFieldsHex.png +0 -0
  135. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapBasinSionnachHex.png +0 -0
  136. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapCallahansPassageHex.png +0 -0
  137. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapCallumsCapeHex.png +0 -0
  138. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapClahstraHex.png +0 -0
  139. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapClansheadValleyHex.png +0 -0
  140. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapDeadlandsHex.png +0 -0
  141. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapDrownedValeHex.png +0 -0
  142. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapEndlessShoreHex.png +0 -0
  143. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapFarranacCoastHex.png +0 -0
  144. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapFishermansRowHex.png +0 -0
  145. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapGodcroftsHex.png +0 -0
  146. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapGreatMarchHex.png +0 -0
  147. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapHeartlandsHex.png +0 -0
  148. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapHomeRegionC.png +0 -0
  149. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapHomeRegionW.png +0 -0
  150. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapHowlCountyHex.png +0 -0
  151. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapKalokaiHex.png +0 -0
  152. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapKingsCageHex.png +0 -0
  153. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapLinnMercyHex.png +0 -0
  154. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapLochMorHex.png +0 -0
  155. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapMarbanHollow.png +0 -0
  156. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapMooringCountyHex.png +0 -0
  157. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapMorgensCrossingHex.png +0 -0
  158. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapNevishLineHex.png +0 -0
  159. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapOarbreakerHex.png +0 -0
  160. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapOriginHex.png +0 -0
  161. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapReachingTrailHex.png +0 -0
  162. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapReaversPassHex.png +0 -0
  163. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapRedRiverHex.png +0 -0
  164. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapSableportHex.png +0 -0
  165. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapShackledChasmHex.png +0 -0
  166. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapSpeakingWoodsHex.png +0 -0
  167. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapStemaLandingHex.png +0 -0
  168. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapStlicanShelfHex.png +0 -0
  169. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapStonecradleHex.png +0 -0
  170. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapTempestIslandHex.png +0 -0
  171. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapTerminusHex.png +0 -0
  172. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapTheFingersHex.png +0 -0
  173. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapUmbralWildwoodHex.png +0 -0
  174. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapViperPitHex.png +0 -0
  175. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapWeatheredExpanseHex.png +0 -0
  176. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/Images/MapsHex/MapWestgateHex.png +0 -0
  177. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/__init__.py +0 -0
  178. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi/utils.py +0 -0
  179. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi.egg-info/SOURCES.txt +0 -0
  180. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi.egg-info/dependency_links.txt +0 -0
  181. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi.egg-info/requires.txt +0 -0
  182. {foxapi-1.1.4 → foxapi-1.2.0}/foxapi.egg-info/top_level.txt +0 -0
  183. {foxapi-1.1.4 → foxapi-1.2.0}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: foxapi
3
- Version: 1.1.4
3
+ Version: 1.2.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
@@ -18,8 +18,6 @@ Requires-Dist: pillow
18
18
 
19
19
  # FoxAPI Documentation
20
20
 
21
- #### If you use the PyPi version, you might need to download manually the `Images` folder in the [github](https://github.com/ThePhoenix78/FoxAPI/tree/main/foxapi) and pass it as an argument like `fox = FoxAPI(image_dir="Images")`
22
-
23
21
  ## Installation
24
22
  ```bash
25
23
  pip install foxapi
@@ -37,7 +35,6 @@ Also, if you work with discord.py or any asynchronous API, this tool might be us
37
35
  - [Dependencies](#dependencies)
38
36
  - [Wrapper](#wrapper)
39
37
  - [Methods](#methods)
40
- - [API Interaction](#api-interaction)
41
38
  - [Map and War Data](#map-and-war-data)
42
39
  - [Hexagon Operations](#hexagon-operations)
43
40
  - [Listener Functions](#listener-functions)
@@ -53,7 +50,7 @@ Also, if you work with discord.py or any asynchronous API, this tool might be us
53
50
 
54
51
  ## Wrapper
55
52
 
56
- ```python
53
+ ```py
57
54
  class FoxAPI(shard: str = "", image_dir: str = None, safe_mode: bool = True)
58
55
  ```
59
56
 
@@ -64,66 +61,99 @@ class FoxAPI(shard: str = "", image_dir: str = None, safe_mode: bool = True)
64
61
 
65
62
  #### Note : all of theses methods are async, to run the synchronous version, add _sync at the end (see API example)
66
63
 
67
- - **get_data(endpoint: str, etag: str = None, use_cache: bool = False) -> APIResponse**
64
+ ```py
65
+ get_data(endpoint: str, etag: str = None, use_cache: bool = False) -> APIResponse
66
+ ```
68
67
  Fetches data from the specified endpoint, you can choose to use cache instead of sending a request and you can pass ETag.
69
68
 
70
69
  - Parameters:
71
70
  - `endpoint` (str): The API endpoint to call.
72
71
  - `etag` (str, optional): The ETag header for cache validation (not required since managed natively).
73
- - `cache` (bool, optional): Whether to use cached data (default: False).
72
+ - `use_cache` (bool, optional): Whether to use cached data (default: False).
74
73
 
75
74
  - Returns: The response data from the API as a APIResponse object.
76
75
 
77
76
  ### Map and War Data
78
77
 
79
- - **get_maps(use_cache: bool = True) -> list**
80
- Retrieves a list of available hexagons (maps) in the game world.
78
+ ```py
79
+ get_maps(use_cache: bool = True) -> list
80
+ ```
81
+ - Retrieves a list of available hexagons (maps) in the game world.
81
82
 
82
- - **get_war(use_cache: bool = False) -> dict**
83
- Retrieves the current war state (war data).
83
+ ```py
84
+ get_war(use_cache: bool = False) -> dict
85
+ ```
86
+ - Retrieves the current war state (war data).
84
87
 
85
- - **get_static(hexagon: str, use_cache: bool = False) -> dict**
86
- Retrieves the static data for the specified hexagon.
88
+ ```py
89
+ get_static(hexagon: str, use_cache: bool = False) -> dict
90
+ ```
87
91
 
88
- - **get_dynamic(hexagon: str, use_cache: bool = False) -> dict**
89
- Retrieves the dynamic data for the specified hexagon.
92
+ - Retrieves the static data for the specified hexagon.
90
93
 
91
- - **get_war_report(hexagon: str, use_cache: bool = False) -> dict**
92
- Retrieves the war report for the specified hexagon.
94
+ ```py
95
+ get_dynamic(hexagon: str, use_cache: bool = False) -> dict
96
+ ```
97
+ - Retrieves the dynamic data for the specified hexagon.
93
98
 
94
- - **get_hexagon_data(hexagon: str, use_cache: bool = False) -> HexagonObject**
95
- Retrieves all the data awailable for the specified hexagon.
99
+ ```py
100
+ get_war_report(hexagon: str, use_cache: bool = False) -> dict
101
+ ```
102
+ - Retrieves the war report for the specified hexagon.
103
+
104
+ ```py
105
+ get_hexagon_data(hexagon: str, use_cache: bool = False) -> HexagonObject
106
+ ```
107
+
108
+ - Retrieves all the data awailable for the specified hexagon.
96
109
 
97
110
  ### Hexagon Operations
98
111
 
99
- - **await calc_distance(x1: float, y1: float, x2: float, y2: float) -> float**
100
- Calculates the Euclidean distance between two points on the map.
112
+ ```py
113
+ calc_distance(x1: float, y1: float, x2: float, y2: float) -> float
114
+ ```
101
115
 
102
- - **await get_captured_towns(hexagon: str = None, dynamic: dict = None, static: dict = None) -> dict**
103
- Retrieves the captured towns for a given hexagon based on dynamic and static data.
116
+ - Calculates the Euclidean distance between two points on the map.
104
117
 
105
- - **load_hexagon_map(hexagon: str) -> pillow.Image**
106
- Loads the PNG map for the specified hexagon.
118
+ ```py
119
+ get_captured_towns(hexagon: str = None, dynamic: dict = None, static: dict = None) -> dict
120
+ ```
121
+ - Retrieves the captured towns for a given hexagon based on dynamic and static data.
122
+
123
+ ```py
124
+ load_hexagon_map(hexagon: str) -> pillow.Image
125
+ ```
126
+
127
+ - Loads the PNG map for the specified hexagon.
128
+
129
+ ```py
130
+ make_map_png(hexagon: str, dynamic: dict = None, static: dict = None) -> pillow.Image
131
+ ```
132
+ - 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.
107
133
 
108
- - **make_map_png(hexagon: str, dynamic: dict = None, static: dict = None) -> pillow.Image**
109
- 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.
110
134
 
111
- - **calculate_death_rate(hexagon: str = None, war_report: dict = None): -> dict**
112
- calculate the death rate between the first launch and the current one
135
+ ```py
136
+ calculate_death_rate(hexagon: str = None, war_report: dict = None): -> dict
137
+ ```
138
+ - calculate the death rate between the first launch and the current one
113
139
 
114
140
  ### Listener Functions
115
141
 
116
- - **on_api_update(callback: callable = None, endpoints: list = None)**
117
- Registers a callback function to be called when the data for specified API endpoints is updated.
142
+ ```py
143
+ on_api_update(callback: callable = None, endpoints: list = None)
144
+ ```
145
+ - Registers a callback function to be called when the data for specified API endpoints is updated.
118
146
 
119
- - **on_hexagon_update(callback: callable = None, hexagons: list = None)**
120
- Registers a callback function to be called when the data for specified hexagons is updated.
147
+ ```py
148
+ on_hexagon_update(callback: callable = None, hexagons: list = "all")
149
+ ```
150
+ - Registers a callback function to be called when the data for specified hexagons is updated.
121
151
 
122
152
  ## Error Handling
123
153
 
124
- - **EndpointError**: Raised if an invalid API endpoint is used.
125
- - **HexagonError**: Raised if an invalid hexagon is provided.
126
- - **FoxAPIError**: A general error for issues within the FoxAPI class (e.g., missing data).
154
+ ```pyEndpointError```: Raised if an invalid API endpoint is used.
155
+ ```pyHexagonError```: Raised if an invalid hexagon is provided.
156
+ ```pyFoxAPIError```: A general error for issues within the FoxAPI class (e.g., missing data).
127
157
 
128
158
 
129
159
  ## Objects
@@ -135,7 +165,7 @@ class APIResponse:
135
165
  self.json: dict = json
136
166
  self.status_code: int = status_code
137
167
  self.hexagon: str = hexagon
138
- self.is_use_cache: bool = is_cache
168
+ self.is_cache: bool = is_cache
139
169
 
140
170
 
141
171
  class HexagonObject:
@@ -162,13 +192,10 @@ from foxapi import FoxAPI
162
192
  # api calls and hexagons name into valid ones
163
193
  # Ex: deadlands -> DeadLandsHex (Yes, I am *that* lazy)
164
194
 
165
- # don't forget to download the image folder https://github.com/ThePhoenix78/FoxAPI/tree/main/foxapi
166
-
167
- fox = FoxAPI(shard="1", image_dir="Images")
195
+ fox = FoxAPI(shard="1")
168
196
 
169
- hexagon: str = "DeadLandsHex"
170
197
 
171
- def function(hexagon: str):
198
+ def function(hexagon: str = "DeadLandsHex"):
172
199
  # Get the list of available hexagons (maps) and state of the current war
173
200
  maps: list = fox.get_maps_sync()
174
201
  war: dict = fox.get_war_sync()
@@ -188,7 +215,7 @@ def function(hexagon: str):
188
215
 
189
216
  # Async equivalent
190
217
 
191
- async def function(hexagon: str):
218
+ async def function(hexagon: str = "DeadLandsHex"):
192
219
  # Get the list of available hexagons (maps) and state of the current war
193
220
  maps: list = await fox.get_maps()
194
221
  war: dict = await fox.get_war()
@@ -224,6 +251,5 @@ async def on_update(hexa: HexagonObject):
224
251
  hexa.image.save(f"{hexa.hexagon}.png")
225
252
 
226
253
  ```
227
- (Yes, most of this documentation has been generated with ChatGPT, I am alone and too lazy to do that)
228
254
 
229
255
  #### I am not responsible for what you are doing with it
@@ -1,7 +1,5 @@
1
1
  # FoxAPI Documentation
2
2
 
3
- #### If you use the PyPi version, you might need to download manually the `Images` folder in the [github](https://github.com/ThePhoenix78/FoxAPI/tree/main/foxapi) and pass it as an argument like `fox = FoxAPI(image_dir="Images")`
4
-
5
3
  ## Installation
6
4
  ```bash
7
5
  pip install foxapi
@@ -19,7 +17,6 @@ Also, if you work with discord.py or any asynchronous API, this tool might be us
19
17
  - [Dependencies](#dependencies)
20
18
  - [Wrapper](#wrapper)
21
19
  - [Methods](#methods)
22
- - [API Interaction](#api-interaction)
23
20
  - [Map and War Data](#map-and-war-data)
24
21
  - [Hexagon Operations](#hexagon-operations)
25
22
  - [Listener Functions](#listener-functions)
@@ -35,7 +32,7 @@ Also, if you work with discord.py or any asynchronous API, this tool might be us
35
32
 
36
33
  ## Wrapper
37
34
 
38
- ```python
35
+ ```py
39
36
  class FoxAPI(shard: str = "", image_dir: str = None, safe_mode: bool = True)
40
37
  ```
41
38
 
@@ -46,66 +43,99 @@ class FoxAPI(shard: str = "", image_dir: str = None, safe_mode: bool = True)
46
43
 
47
44
  #### Note : all of theses methods are async, to run the synchronous version, add _sync at the end (see API example)
48
45
 
49
- - **get_data(endpoint: str, etag: str = None, use_cache: bool = False) -> APIResponse**
46
+ ```py
47
+ get_data(endpoint: str, etag: str = None, use_cache: bool = False) -> APIResponse
48
+ ```
50
49
  Fetches data from the specified endpoint, you can choose to use cache instead of sending a request and you can pass ETag.
51
50
 
52
51
  - Parameters:
53
52
  - `endpoint` (str): The API endpoint to call.
54
53
  - `etag` (str, optional): The ETag header for cache validation (not required since managed natively).
55
- - `cache` (bool, optional): Whether to use cached data (default: False).
54
+ - `use_cache` (bool, optional): Whether to use cached data (default: False).
56
55
 
57
56
  - Returns: The response data from the API as a APIResponse object.
58
57
 
59
58
  ### Map and War Data
60
59
 
61
- - **get_maps(use_cache: bool = True) -> list**
62
- Retrieves a list of available hexagons (maps) in the game world.
60
+ ```py
61
+ get_maps(use_cache: bool = True) -> list
62
+ ```
63
+ - Retrieves a list of available hexagons (maps) in the game world.
63
64
 
64
- - **get_war(use_cache: bool = False) -> dict**
65
- Retrieves the current war state (war data).
65
+ ```py
66
+ get_war(use_cache: bool = False) -> dict
67
+ ```
68
+ - Retrieves the current war state (war data).
66
69
 
67
- - **get_static(hexagon: str, use_cache: bool = False) -> dict**
68
- Retrieves the static data for the specified hexagon.
70
+ ```py
71
+ get_static(hexagon: str, use_cache: bool = False) -> dict
72
+ ```
69
73
 
70
- - **get_dynamic(hexagon: str, use_cache: bool = False) -> dict**
71
- Retrieves the dynamic data for the specified hexagon.
74
+ - Retrieves the static data for the specified hexagon.
72
75
 
73
- - **get_war_report(hexagon: str, use_cache: bool = False) -> dict**
74
- Retrieves the war report for the specified hexagon.
76
+ ```py
77
+ get_dynamic(hexagon: str, use_cache: bool = False) -> dict
78
+ ```
79
+ - Retrieves the dynamic data for the specified hexagon.
75
80
 
76
- - **get_hexagon_data(hexagon: str, use_cache: bool = False) -> HexagonObject**
77
- Retrieves all the data awailable for the specified hexagon.
81
+ ```py
82
+ get_war_report(hexagon: str, use_cache: bool = False) -> dict
83
+ ```
84
+ - Retrieves the war report for the specified hexagon.
85
+
86
+ ```py
87
+ get_hexagon_data(hexagon: str, use_cache: bool = False) -> HexagonObject
88
+ ```
89
+
90
+ - Retrieves all the data awailable for the specified hexagon.
78
91
 
79
92
  ### Hexagon Operations
80
93
 
81
- - **await calc_distance(x1: float, y1: float, x2: float, y2: float) -> float**
82
- Calculates the Euclidean distance between two points on the map.
94
+ ```py
95
+ calc_distance(x1: float, y1: float, x2: float, y2: float) -> float
96
+ ```
83
97
 
84
- - **await get_captured_towns(hexagon: str = None, dynamic: dict = None, static: dict = None) -> dict**
85
- Retrieves the captured towns for a given hexagon based on dynamic and static data.
98
+ - Calculates the Euclidean distance between two points on the map.
86
99
 
87
- - **load_hexagon_map(hexagon: str) -> pillow.Image**
88
- Loads the PNG map for the specified hexagon.
100
+ ```py
101
+ get_captured_towns(hexagon: str = None, dynamic: dict = None, static: dict = None) -> dict
102
+ ```
103
+ - Retrieves the captured towns for a given hexagon based on dynamic and static data.
104
+
105
+ ```py
106
+ load_hexagon_map(hexagon: str) -> pillow.Image
107
+ ```
108
+
109
+ - Loads the PNG map for the specified hexagon.
110
+
111
+ ```py
112
+ make_map_png(hexagon: str, dynamic: dict = None, static: dict = None) -> pillow.Image
113
+ ```
114
+ - 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.
89
115
 
90
- - **make_map_png(hexagon: str, dynamic: dict = None, static: dict = None) -> pillow.Image**
91
- 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.
92
116
 
93
- - **calculate_death_rate(hexagon: str = None, war_report: dict = None): -> dict**
94
- calculate the death rate between the first launch and the current one
117
+ ```py
118
+ calculate_death_rate(hexagon: str = None, war_report: dict = None): -> dict
119
+ ```
120
+ - calculate the death rate between the first launch and the current one
95
121
 
96
122
  ### Listener Functions
97
123
 
98
- - **on_api_update(callback: callable = None, endpoints: list = None)**
99
- Registers a callback function to be called when the data for specified API endpoints is updated.
124
+ ```py
125
+ on_api_update(callback: callable = None, endpoints: list = None)
126
+ ```
127
+ - Registers a callback function to be called when the data for specified API endpoints is updated.
100
128
 
101
- - **on_hexagon_update(callback: callable = None, hexagons: list = None)**
102
- Registers a callback function to be called when the data for specified hexagons is updated.
129
+ ```py
130
+ on_hexagon_update(callback: callable = None, hexagons: list = "all")
131
+ ```
132
+ - Registers a callback function to be called when the data for specified hexagons is updated.
103
133
 
104
134
  ## Error Handling
105
135
 
106
- - **EndpointError**: Raised if an invalid API endpoint is used.
107
- - **HexagonError**: Raised if an invalid hexagon is provided.
108
- - **FoxAPIError**: A general error for issues within the FoxAPI class (e.g., missing data).
136
+ ```pyEndpointError```: Raised if an invalid API endpoint is used.
137
+ ```pyHexagonError```: Raised if an invalid hexagon is provided.
138
+ ```pyFoxAPIError```: A general error for issues within the FoxAPI class (e.g., missing data).
109
139
 
110
140
 
111
141
  ## Objects
@@ -117,7 +147,7 @@ class APIResponse:
117
147
  self.json: dict = json
118
148
  self.status_code: int = status_code
119
149
  self.hexagon: str = hexagon
120
- self.is_use_cache: bool = is_cache
150
+ self.is_cache: bool = is_cache
121
151
 
122
152
 
123
153
  class HexagonObject:
@@ -144,13 +174,10 @@ from foxapi import FoxAPI
144
174
  # api calls and hexagons name into valid ones
145
175
  # Ex: deadlands -> DeadLandsHex (Yes, I am *that* lazy)
146
176
 
147
- # don't forget to download the image folder https://github.com/ThePhoenix78/FoxAPI/tree/main/foxapi
148
-
149
- fox = FoxAPI(shard="1", image_dir="Images")
177
+ fox = FoxAPI(shard="1")
150
178
 
151
- hexagon: str = "DeadLandsHex"
152
179
 
153
- def function(hexagon: str):
180
+ def function(hexagon: str = "DeadLandsHex"):
154
181
  # Get the list of available hexagons (maps) and state of the current war
155
182
  maps: list = fox.get_maps_sync()
156
183
  war: dict = fox.get_war_sync()
@@ -170,7 +197,7 @@ def function(hexagon: str):
170
197
 
171
198
  # Async equivalent
172
199
 
173
- async def function(hexagon: str):
200
+ async def function(hexagon: str = "DeadLandsHex"):
174
201
  # Get the list of available hexagons (maps) and state of the current war
175
202
  maps: list = await fox.get_maps()
176
203
  war: dict = await fox.get_war()
@@ -206,6 +233,5 @@ async def on_update(hexa: HexagonObject):
206
233
  hexa.image.save(f"{hexa.hexagon}.png")
207
234
 
208
235
  ```
209
- (Yes, most of this documentation has been generated with ChatGPT, I am alone and too lazy to do that)
210
236
 
211
237
  #### I am not responsible for what you are doing with it
@@ -22,7 +22,7 @@ import os
22
22
 
23
23
  class FoxAPI():
24
24
  def __init__(self, shard: str = "", image_dir: str = None, safe_mode: bool = True):
25
- if shard in [1, "1"]:
25
+ if shard in [1, "1", "-1"]:
26
26
  shard: str = ""
27
27
 
28
28
  elif shard in [2, "2", "-2"]:
@@ -452,7 +452,7 @@ class FoxAPI():
452
452
  CRAWLER ASYNC
453
453
  """
454
454
 
455
- async def _litsener(self):
455
+ async def _listener(self):
456
456
  await asyncio.sleep(.1)
457
457
 
458
458
  while self._run:
@@ -475,7 +475,7 @@ class FoxAPI():
475
475
  CRAWLER SYNC
476
476
  """
477
477
 
478
- def _litsener_sync(self):
478
+ def _listener_sync(self):
479
479
  time.sleep(.1)
480
480
 
481
481
  while self._run:
@@ -493,14 +493,14 @@ class FoxAPI():
493
493
  self._cpt_rate += 1
494
494
  time.sleep(self._refresh)
495
495
 
496
- def _check_litsener(self, run_async: bool = True):
496
+ def _check_listener(self, run_async: bool = True):
497
497
  if not self._run:
498
498
  self._run: bool = True
499
- # threading.Thread(target=self._litsener).start()
499
+ # threading.Thread(target=self._listener).start()
500
500
  if run_async:
501
- self.start_async_thread(self._litsener())
501
+ self.start_async_thread(self._listener())
502
502
  else:
503
- threading.Thread(target=self._litsener_sync).start()
503
+ threading.Thread(target=self._listener_sync).start()
504
504
  # threading.Thread(target=self.start_async_thread).start()
505
505
 
506
506
  """
@@ -577,7 +577,7 @@ class FoxAPI():
577
577
  raise EndpointError(f"{endpoints[i]} not valid! Please enter a valid endpoint (FoxAPI._valid_endpoints)")
578
578
 
579
579
  def add_debug(func):
580
- self._check_litsener(asyncio.iscoroutinefunction(func))
580
+ self._check_listener(asyncio.iscoroutinefunction(func))
581
581
 
582
582
  for endpoint in endpoints:
583
583
  self._to_call[endpoint]: callable = func
@@ -589,7 +589,7 @@ class FoxAPI():
589
589
 
590
590
  return add_debug
591
591
 
592
- def on_hexagon_update(self, callback: callable = "all", hexagons: list = None):
592
+ def on_hexagon_update(self, callback: callable = None, hexagons: list = "all"):
593
593
  if (isinstance(callback, str) or isinstance(callback, list)) and hexagons is None:
594
594
  hexagons: str = callback
595
595
  callback: callable = None
@@ -608,7 +608,7 @@ class FoxAPI():
608
608
  raise HexagonError("Please enter a valid hexagon (FoxAPi.available_hexagons")
609
609
 
610
610
  def add_debug(func):
611
- self._check_litsener(asyncio.iscoroutinefunction(func))
611
+ self._check_listener(asyncio.iscoroutinefunction(func))
612
612
 
613
613
  for hexagon in hexagons:
614
614
  ends: list = [f"/warReport/{hexagon}", f"/maps/{hexagon}/dynamic/public", f"/maps/{hexagon}/static"]