minecraft-server-status 0.0.1__py3-none-any.whl

minecraft_server_status/__init__.py

@@ -0,0 +1,4 @@
+from .bedrock import Bedrock
+from .java import Java
+
+__all__ = ["Bedrock", "Java"]

minecraft_server_status/bedrock.py

@@ -0,0 +1,64 @@
+import requests
+import time
+
+class Bedrock:
+    def __init__(self, ip, port=19132, ttl = 10):
+        self.ip = ip
+        self.port = port
+        self._data = None
+        self._last_fetch = 0
+        self.ttl = ttl
+
+    def _fetch(self):
+        now = time.time()
+
+        if self._data is None or (now - self._last_fetch) > self.ttl:   # only fetch once
+            try:
+                res = requests.get(
+                    f"https://api.mcstatus.io/v2/status/bedrock/{self.ip}:{self.port}",
+                    timeout=5
+                )
+                self._data = res.json()
+                self._last_fetch = now
+            except Exception as e:
+                # if request fails, keep old data instead of crashing
+                if self._data is None:
+                    self._data = {"online": False, "error": str(e)}
+
+        return self._data
+
+    def status(self):
+        return self._fetch()["online"] or None
+
+    def ip_address(self):
+        return self._fetch()["ip_address"] or None
+
+    def port_number(self):
+        return self._fetch()["port"] or None
+    
+    def expires_at(self):
+        return self._fetch()["expires_at"] or None
+    
+    def server_minecraft_version(self):
+        return self._fetch()["version"] or None
+    
+    def players(self):
+        return self._fetch()["players"] or None
+    
+    def gameMode(self):
+        return self._fetch()["gamemode"] or None
+    
+    def server_id(self):
+        return self._fetch()["server_id"] or None
+    
+    def edition(self):
+        return self._fetch()["edition"] or None
+    
+    def software(self):
+        return self._fetch()["software"] or None
+    
+    def plugins(self):
+        return self._fetch()["plugins"] or []
+
+    def raw(self):
+        return self._fetch()

minecraft_server_status/java.py

@@ -0,0 +1,63 @@
+import requests
+import time
+
+class Java:
+    def __init__(self, ip, port=25565, ttl = 10):
+        self.ip = ip
+        self.port = port
+        self._data = None
+        self._last_fetch = 0
+        self.ttl = ttl
+
+    def _fetchJ(self):
+        now  = time.time()
+
+        if self._data is None or (now - self._last_fetch)>self.ttl:
+            try:
+                data = requests.get(f"https://api.mcstatus.io/v2/status/java/{self.ip}:{self.port}", timeout=5)
+                self._data = data.json()
+                self._last_fetch = now
+
+            except Exception as e:
+                # if request fails, keep old data instead of crashing
+                if self._data is None:
+                    self._data = {"online": False, "error": str(e)}
+
+        return self._data
+    
+    def status(self):
+        return self._fetchJ()["online"] or None
+    
+    def ip(self):
+        return self._fetchJ()["ip_address"] or None
+    
+    def expires_at(self):
+        return self._fetchJ()["expires_at"] or None
+    
+    def srv_record(self):
+        return self._fetchJ()["srv_record"] or None
+    
+    def java_minecraft_version(self):
+        return self._fetchJ()["version"] or None
+    
+    def players(self):
+        return self._fetchJ()["players"] or None
+    
+    def message_of_the_day(self):
+        return self._fetchJ()["motd"] or None
+    
+    def icon(self):
+        return self._fetchJ()["icon"] or None
+    
+    def mods(self):
+        return self._fetchJ()["mods"] or None
+    
+    def software(self):
+        return self._fetchJ()["software"] or None
+    
+    def plugins(self):
+        return self._fetchJ()["plugins"] or []
+    
+    def raw(self):
+        return self._fetchJ()
+    

minecraft_server_status-0.0.1.dist-info/METADATA

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: minecraft_server_status
+Version: 0.0.1
+Summary: Python package for fetching Minecraft Java and Bedrock server status, players, version, and plugins.
+Author-email: Arpit Jaiswal <arpitjaiswal9526@gmail.com>
+License: The MIT License (MIT)
+        Copyright © 2026 Arpit Jaiswal
+        
+        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.
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: License
+Requires-Dist: requests
+Dynamic: license-file
+
+# minecraft_server_status
+
+A lightweight Python package to fetch **Minecraft Java** and **Minecraft Bedrock** server status using the public **mcstatus.io API**.
+
+This package provides simple classes and methods to check whether a server is online, view player counts, server version, plugins, software, and more — without handling raw HTTP requests yourself.
+
+---
+
+## Features
+
+* Supports **Minecraft Java Edition**
+* Supports **Minecraft Bedrock Edition**
+* **TTL-based caching** (auto refresh after set time)
+* **Fail-safe network handling** (doesn’t crash on request errors)
+* Configurable **timeout & TTL**
+* Clean and simple method-based access
+* Full **raw JSON** access available
+* Minimal dependency (`requests` only)
+
+---
+
+## Installation
+
+Once published to PyPI:
+
+```bash
+pip install minecraft_server_status
+```
+
+For local development:
+
+```bash
+pip install -e .
+```
+
+---
+
+## Requirements
+
+* Python **3.9+**
+* `requests`
+
+---
+
+## Project Structure
+
+```
+minecraft_server_status/
+│
+├── pyproject.toml
+├── README.md
+├── LICENSE
+└── src/
+    └── minecraft_server_status/
+        ├── __init__.py
+        ├── java.py
+        └── bedrock.py
+```
+
+---
+
+## Quick Start
+
+### Java Server Example
+
+```python
+from minecraft_server_status import Java
+
+# ttl = cache time in seconds (default 10)
+server = Java("hypixel.net", ttl=15)
+
+print(server.status())                 # True / False
+print(server.players())                # Player information
+print(server.java_minecraft_version()) # Version details
+print(server.plugins())                # Plugin list
+print(server.raw())                    # Full JSON response
+```
+
+---
+
+### Bedrock Server Example
+
+```python
+from minecraft_server_status import Bedrock
+
+server = Bedrock("play.example.com", ttl=20)
+
+print(server.status())
+print(server.players())
+print(server.server_minecraft_version())
+print(server.software())
+print(server.raw())
+```
+
+---
+
+## TTL Caching Explained
+
+TTL (**Time To Live**) controls how often the API is called.
+
+Example:
+
+```python
+server = Java("hypixel.net", ttl=30)
+```
+
+* First call → Fetches API
+* Next calls within 30 sec → Uses cached data
+* After 30 sec → Auto refreshes
+
+This prevents:
+
+* API spam
+* Rate limits
+* Slow performance
+
+---
+
+## Error Handling
+
+If the API request fails:
+
+* The package **does not crash**
+* Old cached data is reused
+* If no previous data exists → returns:
+
+```python
+{"online": False, "error": "..."}
+```
+
+---
+
+## Java Class Methods
+
+| Method                     | Description                |
+| -------------------------- | -------------------------- |
+| `status()`                 | Returns online status      |
+| `ip()`                     | Resolved IP address        |
+| `expires_at()`             | Cache expiration timestamp |
+| `srv_record()`             | SRV record information     |
+| `java_minecraft_version()` | Minecraft version data     |
+| `players()`                | Player count & sample list |
+| `message_of_the_day()`     | Server MOTD                |
+| `icon()`                   | Base64 server icon         |
+| `mods()`                   | Installed mods             |
+| `software()`               | Server software name       |
+| `plugins()`                | Plugin list                |
+| `raw()`                    | Full API JSON              |
+
+---
+
+## Bedrock Class Methods
+
+| Method                       | Description                |
+| ---------------------------- | -------------------------- |
+| `status()`                   | Online status              |
+| `ip_address()`               | Resolved IP                |
+| `port_number()`              | Server port                |
+| `expires_at()`               | Cache expiration timestamp |
+| `server_minecraft_version()` | Version details            |
+| `players()`                  | Player data                |
+| `gameMode()`                 | Current game mode          |
+| `server_id()`                | Unique server ID           |
+| `edition()`                  | Bedrock edition info       |
+| `software()`                 | Server software            |
+| `plugins()`                  | Plugin list                |
+| `raw()`                      | Full API JSON              |
+
+---
+
+## How It Works
+
+* Uses `https://api.mcstatus.io` internally
+* Data is cached with **TTL**
+* Network errors are handled gracefully
+* Multiple method calls **do not trigger multiple API requests**
+* Designed for bots, dashboards, and quick checks
+
+---
+
+## Notes
+
+* If a field is unavailable, the method returns `None`
+* Not intended for high-frequency real-time monitoring
+* Depends on the availability of the mcstatus.io API
+
+---
+
+## License
+
+MIT License — see `LICENSE` file.
+
+---
+
+## Author
+
+**Arpit Jaiswal**
+
+GitHub: [https://github.com/Arp1it](https://github.com/Arp1it)
+
+---
+
+## Contributing
+
+Pull requests, bug reports, and improvements are welcome 🚀

minecraft_server_status-0.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+minecraft_server_status/__init__.py,sha256=mfz8hFdkVVzs_hLhUKF87QTt9hidK0zK5wJHYrW5f18,85
+minecraft_server_status/bedrock.py,sha256=9sII_MIMlLPfy9rpeJXXmkY8ZMkivlfNxKkMvLIAMuk,1834
+minecraft_server_status/java.py,sha256=vVB4L5ZmVgNQ6nKhcrLWBHktBg8jxl6srUNND0WSEes,1770
+minecraft_server_status-0.0.1.dist-info/licenses/License,sha256=HuF-5MUIM5L00Iw7lZNfVwyGzGe087dunonyyn1XdSE,1084
+minecraft_server_status-0.0.1.dist-info/METADATA,sha256=Om_z_c6njJHuoxsgy6-3FJD9gceZMOK5Vk2_ncVc4iI,6697
+minecraft_server_status-0.0.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+minecraft_server_status-0.0.1.dist-info/top_level.txt,sha256=euUTavhTiqGBpgjixixZuikd37LS6YYTwUpo5YFYyXQ,24
+minecraft_server_status-0.0.1.dist-info/RECORD,,

minecraft_server_status-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

minecraft_server_status-0.0.1.dist-info/licenses/License

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2026 Arpit Jaiswal
+
+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.

minecraft_server_status-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+minecraft_server_status