apiverve-rockpaperscissors 1.1.14__tar.gz

apiverve_rockpaperscissors-1.1.14/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 APIVerve, and Evlar LLC
+
+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.

apiverve_rockpaperscissors-1.1.14/PKG-INFO

@@ -0,0 +1,385 @@
+Metadata-Version: 2.4
+Name: apiverve-rockpaperscissors
+Version: 1.1.14
+Summary: Rock Paper Scissors API simulates the classic hand game with detailed outcome analysis, statistics, and support for multiple rounds.
+Author-email: APIVerve <hello@apiverve.com>
+License: MIT
+Project-URL: Homepage, https://apiverve.com?utm_source=pypi
+Project-URL: Repository, https://github.com/apiverve/rockpaperscissors-api
+Project-URL: Documentation, https://docs.apiverve.com/api/rockpaperscissors?utm_source=pypi
+Project-URL: Twitter, https://twitter.com/apivervehq
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Healthcare Industry
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Information Technology
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Education
+Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
+Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Internet
+Classifier: Topic :: Communications
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Text Processing
+Classifier: Topic :: Security
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Pre-processors
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Natural Language :: English
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Dynamic: license-file
+
+Rock Paper Scissors API
+============
+
+Rock Paper Scissors API simulates the classic hand game with detailed outcome analysis, statistics, and support for multiple rounds.
+
+![Build Status](https://img.shields.io/badge/build-passing-green)
+![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
+![Prod Ready](https://img.shields.io/badge/production-ready-blue)
+
+This is a Python API Wrapper for the [Rock Paper Scissors API](https://apiverve.com/marketplace/rockpaperscissors?utm_source=pypi&utm_medium=readme)
+
+---
+
+## Installation
+
+Using `pip`:
+
+```bash
+pip install apiverve-rockpaperscissors
+```
+
+Using `pip3`:
+
+```bash
+pip3 install apiverve-rockpaperscissors
+```
+
+---
+
+## Configuration
+
+Before using the rockpaperscissors API client, you have to setup your account and obtain your API Key.
+You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=pypi&utm_medium=readme)
+
+---
+
+## Quick Start
+
+Here's a simple example to get you started quickly:
+
+```python
+from apiverve_rockpaperscissors.apiClient import RockpaperscissorsAPIClient
+
+# Initialize the client with your APIVerve API key
+api = RockpaperscissorsAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "choice": "random",
+    "rounds": 1
+}
+
+try:
+    # Make the API call
+    result = api.execute(query)
+
+    # Print the result
+    print(result)
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+---
+
+## Usage
+
+The Rock Paper Scissors API documentation is found here: [https://docs.apiverve.com/ref/rockpaperscissors](https://docs.apiverve.com/ref/rockpaperscissors?utm_source=pypi&utm_medium=readme).
+You can find parameters, example responses, and status codes documented here.
+
+### Setup
+
+```python
+# Import the client module
+from apiverve_rockpaperscissors.apiClient import RockpaperscissorsAPIClient
+
+# Initialize the client with your APIVerve API key
+api = RockpaperscissorsAPIClient("[YOUR_API_KEY]")
+```
+
+---
+
+## Perform Request
+
+Using the API client, you can perform requests to the API.
+
+###### Define Query
+
+```python
+query = {
+    "choice": "random",
+    "rounds": 1
+}
+```
+
+###### Simple Request
+
+```python
+# Make a request to the API
+result = api.execute(query)
+
+# Print the result
+print(result)
+```
+
+###### Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "total_rounds": 5,
+    "player_choice_mode": "manual",
+    "games": [
+      {
+        "round": 1,
+        "player_choice": "rock",
+        "player_emoji": "🪨",
+        "computer_choice": "paper",
+        "computer_emoji": "📄",
+        "outcome": "computer",
+        "message": "Computer wins! undefined"
+      },
+      {
+        "round": 2,
+        "player_choice": "rock",
+        "player_emoji": "🪨",
+        "computer_choice": "paper",
+        "computer_emoji": "📄",
+        "outcome": "computer",
+        "message": "Computer wins! undefined"
+      },
+      {
+        "round": 3,
+        "player_choice": "rock",
+        "player_emoji": "🪨",
+        "computer_choice": "rock",
+        "computer_emoji": "🪨",
+        "outcome": "tie",
+        "message": "It's a tie! Both chose rock"
+      },
+      {
+        "round": 4,
+        "player_choice": "rock",
+        "player_emoji": "🪨",
+        "computer_choice": "scissors",
+        "computer_emoji": "✂️",
+        "outcome": "player",
+        "message": "You win! Rock crushes scissors"
+      },
+      {
+        "round": 5,
+        "player_choice": "rock",
+        "player_emoji": "🪨",
+        "computer_choice": "paper",
+        "computer_emoji": "📄",
+        "outcome": "computer",
+        "message": "Computer wins! undefined"
+      }
+    ],
+    "results": {
+      "player_wins": 1,
+      "computer_wins": 3,
+      "ties": 1,
+      "player_win_percentage": 20,
+      "computer_win_percentage": 60,
+      "tie_percentage": 20
+    },
+    "overall_winner": "computer",
+    "game_rules": {
+      "rock_beats": "scissors",
+      "paper_beats": "rock",
+      "scissors_beats": "paper"
+    }
+  }
+}
+```
+
+---
+
+## Error Handling
+
+The API client provides comprehensive error handling through the `RockpaperscissorsAPIClientError` exception. Here are some examples:
+
+### Basic Error Handling
+
+```python
+from apiverve_rockpaperscissors.apiClient import RockpaperscissorsAPIClient, RockpaperscissorsAPIClientError
+
+api = RockpaperscissorsAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "choice": "random",
+    "rounds": 1
+}
+
+try:
+    result = api.execute(query)
+    print("Success!")
+    print(result)
+except RockpaperscissorsAPIClientError as e:
+    print(f"API Error: {e.message}")
+    if e.status_code:
+        print(f"Status Code: {e.status_code}")
+    if e.response:
+        print(f"Response: {e.response}")
+```
+
+### Handling Specific Error Types
+
+```python
+from apiverve_rockpaperscissors.apiClient import RockpaperscissorsAPIClient, RockpaperscissorsAPIClientError
+
+api = RockpaperscissorsAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "choice": "random",
+    "rounds": 1
+}
+
+try:
+    result = api.execute(query)
+
+    # Check for successful response
+    if result.get('status') == 'success':
+        print("Request successful!")
+        print(result.get('data'))
+    else:
+        print(f"API returned an error: {result.get('error')}")
+
+except RockpaperscissorsAPIClientError as e:
+    # Handle API client errors
+    if e.status_code == 401:
+        print("Unauthorized: Invalid API key")
+    elif e.status_code == 429:
+        print("Rate limit exceeded")
+    elif e.status_code >= 500:
+        print("Server error - please try again later")
+    else:
+        print(f"API error: {e.message}")
+except Exception as e:
+    # Handle unexpected errors
+    print(f"Unexpected error: {str(e)}")
+```
+
+### Using Context Manager (Recommended)
+
+The client supports the context manager protocol for automatic resource cleanup:
+
+```python
+from apiverve_rockpaperscissors.apiClient import RockpaperscissorsAPIClient, RockpaperscissorsAPIClientError
+
+query = {
+    "choice": "random",
+    "rounds": 1
+}
+
+# Using context manager ensures proper cleanup
+with RockpaperscissorsAPIClient("[YOUR_API_KEY]") as api:
+    try:
+        result = api.execute(query)
+        print(result)
+    except RockpaperscissorsAPIClientError as e:
+        print(f"Error: {e.message}")
+# Session is automatically closed here
+```
+
+---
+
+## Advanced Features
+
+### Debug Mode
+
+Enable debug logging to see detailed request and response information:
+
+```python
+from apiverve_rockpaperscissors.apiClient import RockpaperscissorsAPIClient
+
+# Enable debug mode
+api = RockpaperscissorsAPIClient("[YOUR_API_KEY]", debug=True)
+
+query = {
+    "choice": "random",
+    "rounds": 1
+}
+
+# Debug information will be printed to console
+result = api.execute(query)
+```
+
+### Manual Session Management
+
+If you need to manually manage the session lifecycle:
+
+```python
+from apiverve_rockpaperscissors.apiClient import RockpaperscissorsAPIClient
+
+api = RockpaperscissorsAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "choice": "random",
+    "rounds": 1
+}
+
+try:
+    result = api.execute(query)
+    print(result)
+finally:
+    # Manually close the session when done
+    api.close()
+```
+
+---
+
+## Customer Support
+
+Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=pypi&utm_medium=readme).
+
+---
+
+## Updates
+Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
+
+---
+
+## Legal
+
+All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=pypi&utm_medium=readme) and all legal documents and agreements.
+
+---
+
+## License
+Licensed under the The MIT License (MIT)
+
+Copyright (&copy;) 2026 APIVerve, and EvlarSoft LLC
+
+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.