mc5-api-client 1.0.2__tar.gz

mc5_api_client-1.0.2/.gitignore

@@ -0,0 +1,200 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, it is recommended to include the following files in version control:
+#  - .idea/modules.xml
+#  - .idea/*.iml
+#  - .idea/misc.xml
+#  - .idea/vcs.xml
+.idea/
+
+# VSCode
+.vscode/
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+# MC5 API Client specific
+.mc5/
+token.json
+config.json
+debug.log
+events.json
+*.token
+
+# OS specific
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Temporary files
+*.tmp
+*.temp
+*.swp
+*.swo
+*~
+
+# Log files
+*.log

mc5_api_client-1.0.2/CHANGELOG.md

@@ -0,0 +1,97 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-02-02
+
+### Added
+- Initial release of MC5 API Client by Chizoba
+- Comprehensive authentication system with token generation
+- Support for both user and admin authentication
+- Modern CLI interface with Rich formatting and debug capabilities
+- Full API coverage including:
+  - Profile management
+  - Clan operations
+  - Friend management
+  - Messaging system
+  - Events and tasks
+  - Leaderboard access
+  - Game configuration
+  - Alias and dogtag utilities
+- Automatic token refresh functionality
+- Comprehensive error handling with custom exceptions
+- Type hints throughout the codebase
+- Extensive documentation and examples
+- Unit test coverage
+- PyPI package configuration
+- Development environment setup
+- Python 3.11+ support (beta version)
+
+### Features
+- **Authentication**: Easy token generation and management
+- **CLI**: Rich command-line interface with progress indicators
+- **Auto-refresh**: Automatic token renewal
+- **Error Handling**: Comprehensive exception hierarchy
+- **Type Safety**: Full type annotation support
+- **Documentation**: Detailed README and examples
+- **Testing**: Unit tests with mocking
+- **Configuration**: Persistent config and token storage
+
+### CLI Commands
+- `generate-token` - Generate user access tokens
+- `generate-admin-token` - Generate admin access tokens
+- `validate-token` - Validate saved tokens
+- `show-config` - Display configuration
+- `clear-config` - Clear saved data
+
+### API Endpoints Supported
+- Authentication (Janus)
+- Profile management (Osiris)
+- Clan operations (Osiris)
+- Friend system (Osiris)
+- Messaging (Osiris)
+- Events (Osiris)
+- Leaderboards (Osiris/Olympus)
+- Game objects (Iris)
+- Asset metadata (Iris)
+- Alias lookup (Janus)
+
+### Installation
+```bash
+pip install mc5-api-client
+```
+
+### Development Installation
+```bash
+pip install mc5-api-client[dev]
+```
+
+### Example Usage
+```python
+from mc5_api_client import MC5Client
+
+with MC5Client(username="user", password="pass") as client:
+    profile = client.get_profile()
+    events = client.get_events()
+    client.send_private_message("target", "Hello!")
+```
+
+### CLI Usage
+```bash
+mc5 generate-token --username "user" --password "pass" --save
+mc5 validate-token
+mc5 show-config
+```
+
+---
+
+## [Unreleased]
+
+### Planned
+- Additional API endpoints
+- Enhanced CLI features
+- Performance optimizations
+- More examples and tutorials

mc5_api_client-1.0.2/LICENSE

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

mc5_api_client-1.0.2/MANIFEST.in

@@ -0,0 +1,18 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include requirements.txt
+include requirements-dev.txt
+include pyproject.toml
+include setup.py
+include pytest.ini
+include .gitignore
+recursive-include src *.py
+recursive-include src *.pyi
+recursive-include src *.typed
+recursive-include tests *.py
+recursive-include examples *.py
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * .DS_Store
+recursive-exclude * *.so