wom-py 0.1.0__tar.gz

wom_py-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Jonxslays
+
+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.

wom_py-0.1.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.1
+Name: wom-py
+Version: 0.1.0
+Summary: An asynchronous wrapper for the Wise Old Man API.
+Home-page: https://github.com/Jonxslays/wom.py
+License: MIT
+Author: Jonxslays
+Requires-Python: >=3.8
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: aiohttp (==3.8.4)
+Requires-Dist: attrs (==22.2.0)
+Project-URL: Documentation, https://jonxslays.github.io/wom.py
+Project-URL: Repository, https://github.com/Jonxslays/wom.py
+Description-Content-Type: text/markdown
+
+# wom.py
+
+An asynchronous wrapper for the [Wise Old Man API](https://docs.wiseoldman.net/).
+
+The library aims to make is easy to interact with the Wise Old Man API by
+providing service methods for all available endpoints and model classes
+for data consistency.
+
+## Disclaimer
+
+The library is in early development, and as such features or public interfaces
+may change at any time. Thanks for following our progress!
+
+## Documentation
+
+- [Stable](https://jonxslays.github.io/wom.py/)
+- [Development](https://jonxslays.github.io/wom.py/dev/)
+
+## Installation
+
+### Stable
+
+```sh
+pip install -U wom.py
+```
+
+### Development
+
+```sh
+pip install -U git+https://github.com/Jonxslays/wom.py
+```
+
+For more information on using `pip`, check out the [pip documentation](https://pip.pypa.io/en/stable/).
+
+## What is Wise Old Man
+
+Wise Old Man is an open source Oldschool Runescape player progress tracker.
+
+If you're interested in learning more about the Wise Old Man project, consider checking out any of these links:
+
+- [Website](https://wiseoldman.net/)
+- [API documentation](https://docs.wiseoldman.net/)
+- [Github repository](https://wiseoldman.net/github)
+- [Discord community](https://wiseoldman.net/discord)
+- [Support the developers on Patreon](https://wiseoldman.net/patreon)
+
+Some of the popular features include:
+
+- Experience tracking
+- Boss killcounts
+- Player achievements
+- Group competitions
+- Global leaderboards
+- A discord bot for interacting with the API
+
+## Problems
+
+If you're experiencing a problem with the library, please open an issue
+[here](https://github.com/Jonxslays/wom.py/issues), after first confirming
+a similar issue was not already created.
+
+## Contributing
+
+wom.py is open to contributions.
+
+Come back soon™ once I've written the contributing guide.
+
+## License
+
+wom.py is licensed under the
+[MIT License](https://github.com/Jonxslays/wom.py/blob/master/LICENSE).
+

wom_py-0.1.0/README.md

@@ -0,0 +1,71 @@
+# wom.py
+
+An asynchronous wrapper for the [Wise Old Man API](https://docs.wiseoldman.net/).
+
+The library aims to make is easy to interact with the Wise Old Man API by
+providing service methods for all available endpoints and model classes
+for data consistency.
+
+## Disclaimer
+
+The library is in early development, and as such features or public interfaces
+may change at any time. Thanks for following our progress!
+
+## Documentation
+
+- [Stable](https://jonxslays.github.io/wom.py/)
+- [Development](https://jonxslays.github.io/wom.py/dev/)
+
+## Installation
+
+### Stable
+
+```sh
+pip install -U wom.py
+```
+
+### Development
+
+```sh
+pip install -U git+https://github.com/Jonxslays/wom.py
+```
+
+For more information on using `pip`, check out the [pip documentation](https://pip.pypa.io/en/stable/).
+
+## What is Wise Old Man
+
+Wise Old Man is an open source Oldschool Runescape player progress tracker.
+
+If you're interested in learning more about the Wise Old Man project, consider checking out any of these links:
+
+- [Website](https://wiseoldman.net/)
+- [API documentation](https://docs.wiseoldman.net/)
+- [Github repository](https://wiseoldman.net/github)
+- [Discord community](https://wiseoldman.net/discord)
+- [Support the developers on Patreon](https://wiseoldman.net/patreon)
+
+Some of the popular features include:
+
+- Experience tracking
+- Boss killcounts
+- Player achievements
+- Group competitions
+- Global leaderboards
+- A discord bot for interacting with the API
+
+## Problems
+
+If you're experiencing a problem with the library, please open an issue
+[here](https://github.com/Jonxslays/wom.py/issues), after first confirming
+a similar issue was not already created.
+
+## Contributing
+
+wom.py is open to contributions.
+
+Come back soon™ once I've written the contributing guide.
+
+## License
+
+wom.py is licensed under the
+[MIT License](https://github.com/Jonxslays/wom.py/blob/master/LICENSE).

wom_py-0.1.0/pyproject.toml

@@ -0,0 +1,86 @@
+[tool.poetry]
+name = "wom.py"
+version = "0.1.0"
+description = "An asynchronous wrapper for the Wise Old Man API."
+authors = ["Jonxslays"]
+license = "MIT"
+readme = "README.md"
+homepage = "https://github.com/Jonxslays/wom.py"
+repository = "https://github.com/Jonxslays/wom.py"
+documentation = "https://jonxslays.github.io/wom.py"
+packages = [
+    { include = "wom" },
+    { include = "wom/py.typed" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+
+[tool.poetry.scripts]
+wompy = "wom._cli:info"
+
+[tool.poetry.dependencies]
+python = ">=3.8"
+aiohttp = "==3.8.4"
+attrs = "22.2.0"
+
+[tool.poetry.group.dev.dependencies]
+black = "==23.1.0"
+coverage = "==7.1.0"
+flake8 = { version = "==6.0.0", python = ">=3.8.1" }
+isort = "==5.12.0"
+len8 = { version = "==0.7.3.post0", python = "<3.12" }
+mike = "==1.1.2"
+mkdocs-include-markdown-plugin = { version = "==4.0.3", python = "<3.12" }
+mkdocs-material = "==9.0.13"
+mkdocstrings =  { version = "==0.20.0", extras = ["python"] }
+mypy = "==1.0.0"
+nox = "==2022.11.21"
+pyright = "==1.1.293"
+pytest = "==7.2.1"
+pytest-asyncio = "==0.20.3"
+pytest-testdox = "==3.0.1"
+types-toml = "==0.10.8.3"
+toml = "==0.10.2"
+
+[tool.black]
+line-length = 99
+
+[tool.isort]
+profile = "black"
+force_single_line = true
+
+[tool.len8]
+include = ["noxfile.py", "tests", "wom"]
+code-length = 99
+docs-length = 80
+strict = true
+
+[tool.mypy]
+packages = ["wom"]
+strict = true
+
+[tool.pyright]
+include = ["wom", "tests"]
+typeCheckingMode = "strict"
+reportImportCycles = false
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

wom_py-0.1.0/setup.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+from setuptools import setup
+
+packages = \
+['wom',
+ 'wom.models',
+ 'wom.models.competitions',
+ 'wom.models.deltas',
+ 'wom.models.groups',
+ 'wom.models.names',
+ 'wom.models.players',
+ 'wom.models.records',
+ 'wom.services']
+
+package_data = \
+{'': ['*']}
+
+modules = \
+['py']
+install_requires = \
+['aiohttp==3.8.4', 'attrs==22.2.0']
+
+entry_points = \
+{'console_scripts': ['wompy = wom._cli:info']}
+
+setup_kwargs = {
+    'name': 'wom-py',
+    'version': '0.1.0',
+    'description': 'An asynchronous wrapper for the Wise Old Man API.',
+    'long_description': "# wom.py\n\nAn asynchronous wrapper for the [Wise Old Man API](https://docs.wiseoldman.net/).\n\nThe library aims to make is easy to interact with the Wise Old Man API by\nproviding service methods for all available endpoints and model classes\nfor data consistency.\n\n## Disclaimer\n\nThe library is in early development, and as such features or public interfaces\nmay change at any time. Thanks for following our progress!\n\n## Documentation\n\n- [Stable](https://jonxslays.github.io/wom.py/)\n- [Development](https://jonxslays.github.io/wom.py/dev/)\n\n## Installation\n\n### Stable\n\n```sh\npip install -U wom.py\n```\n\n### Development\n\n```sh\npip install -U git+https://github.com/Jonxslays/wom.py\n```\n\nFor more information on using `pip`, check out the [pip documentation](https://pip.pypa.io/en/stable/).\n\n## What is Wise Old Man\n\nWise Old Man is an open source Oldschool Runescape player progress tracker.\n\nIf you're interested in learning more about the Wise Old Man project, consider checking out any of these links:\n\n- [Website](https://wiseoldman.net/)\n- [API documentation](https://docs.wiseoldman.net/)\n- [Github repository](https://wiseoldman.net/github)\n- [Discord community](https://wiseoldman.net/discord)\n- [Support the developers on Patreon](https://wiseoldman.net/patreon)\n\nSome of the popular features include:\n\n- Experience tracking\n- Boss killcounts\n- Player achievements\n- Group competitions\n- Global leaderboards\n- A discord bot for interacting with the API\n\n## Problems\n\nIf you're experiencing a problem with the library, please open an issue\n[here](https://github.com/Jonxslays/wom.py/issues), after first confirming\na similar issue was not already created.\n\n## Contributing\n\nwom.py is open to contributions.\n\nCome back soon™ once I've written the contributing guide.\n\n## License\n\nwom.py is licensed under the\n[MIT License](https://github.com/Jonxslays/wom.py/blob/master/LICENSE).\n",
+    'author': 'Jonxslays',
+    'author_email': 'None',
+    'maintainer': 'None',
+    'maintainer_email': 'None',
+    'url': 'https://github.com/Jonxslays/wom.py',
+    'packages': packages,
+    'package_data': package_data,
+    'py_modules': modules,
+    'install_requires': install_requires,
+    'entry_points': entry_points,
+    'python_requires': '>=3.8',
+}
+
+
+setup(**setup_kwargs)

wom_py-0.1.0/wom/__init__.py

@@ -0,0 +1,143 @@
+# wom.py - An asynchronous wrapper for the Wise Old Man API.
+# Copyright (c) 2023-present Jonxslays
+#
+# 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.
+
+"""All models, enums, services, etc are exported here in the main
+wom module.
+
+!!! tip
+
+    Know what you're looking for? Hit the search bar ^!
+"""
+
+from __future__ import annotations
+
+from typing import Final
+
+__all__ = (
+    "client",
+    "constants",
+    "enums",
+    "errors",
+    "models",
+    "result",
+    "routes",
+    "serializer",
+    "services",
+    "Achievement",
+    "AchievementMeasure",
+    "AchievementProgress",
+    "Activities",
+    "Activity",
+    "BaseEnum",
+    "Boss",
+    "Bosses",
+    "BaseModel",
+    "Client",
+    "Country",
+    "Competition",
+    "CompetitionDetail",
+    "CompetitionHistoryDataPoint",
+    "CompetitionParticipationDetail",
+    "CompetitionParticipation",
+    "CompetitionProgress",
+    "CompetitionStatus",
+    "CompetitionType",
+    "CompetitionWithParticipations",
+    "CompiledRoute",
+    "ComputedMetric",
+    "ComputedMetrics",
+    "DeltaLeaderboardEntry",
+    "Err",
+    "Gains",
+    "GroupDetail",
+    "GroupHiscoresActivityItem",
+    "GroupHiscoresBossItem",
+    "GroupHiscoresComputedMetricItem",
+    "GroupHiscoresEntry",
+    "GroupHiscoresSkillItem",
+    "GroupMemberFragment",
+    "GroupMembership",
+    "Group",
+    "GroupRole",
+    "GroupStatistics",
+    "HttpErrorResponse",
+    "HttpSuccessResponse",
+    "Membership",
+    "Metric",
+    "NameChangeData",
+    "NameChangeDetail",
+    "NameChange",
+    "NameChangeStatus",
+    "Ok",
+    "Participation",
+    "Period",
+    "PlayerAchievementProgress",
+    "PlayerBuild",
+    "PlayerCompetitionStanding",
+    "PlayerMembership",
+    "Player",
+    "PlayerDetail",
+    "PlayerParticipation",
+    "PlayerType",
+    "Record",
+    "RecordLeaderboardEntry",
+    "Result",
+    "Route",
+    "Serializer",
+    "Skill",
+    "Skills",
+    "SnapshotData",
+    "Snapshot",
+    "StatisticsSnapshot",
+    "Team",
+    "Top5ProgressResult",
+    "UnwrapError",
+    "WomError",
+)
+
+__packagename__: Final[str] = "wom.py"
+__version__: Final[str] = "0.1.0"
+__author__: Final[str] = "Jonxslays"
+__copyright__: Final[str] = "2023-present Jonxslays"
+__description__: Final[str] = "An asynchronous wrapper for the Wise Old Man API."
+__url__: Final[str] = "https://github.com/Jonxslays/wom.py"
+__docs__: Final[str] = "https://jonxslays.github.io/wom.py"
+__repository__: Final[str] = __url__
+__license__: Final[str] = "MIT"
+__git_sha__: Final[str] = "[d194af2]"
+
+from . import client
+from . import constants
+from . import enums
+from . import errors
+from . import models
+from . import result
+from . import routes
+from . import serializer
+from . import services
+from .client import *
+from .enums import *
+from .errors import *
+from .models import *
+from .result import *
+from .routes import *
+from .serializer import *
+from .services import *

wom_py-0.1.0/wom/__main__.py

@@ -0,0 +1,29 @@
+# wom.py - An asynchronous wrapper for the Wise Old Man API.
+# Copyright (c) 2023-present Jonxslays
+#
+# 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.
+
+"""Main module entry point, provides version info and exits."""
+
+from __future__ import annotations
+
+from wom import _cli
+
+if __name__ == "__main__":
+    _cli.info()

wom_py-0.1.0/wom/_cli.py

@@ -0,0 +1,45 @@
+# wom.py - An asynchronous wrapper for the Wise Old Man API.
+# Copyright (c) 2023-present Jonxslays
+#
+# 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.
+
+"""Provides cli functionality for versioning info."""
+
+from __future__ import annotations
+
+import platform
+from pathlib import Path
+
+from wom import __git_sha__
+from wom import __version__
+
+
+def info() -> None:
+    """Prints package/system info and exits."""
+    path = Path(__file__).parent.absolute()
+    py_impl = platform.python_implementation()
+    py_ver = platform.python_version()
+    py_c = platform.python_compiler()
+    p = platform.uname()
+
+    print(f"wom.py v{__version__} from {__git_sha__}")
+    print(f"@ {path}")
+    print(f"{py_impl} {py_ver} {py_c}")
+    print(f"{p.system} {p.node} {p.release} {p.machine}")
+    print(p.version)