Changed code to support older Python versions
This commit is contained in:
Malasaur
parent
eb92d2d36f
commit
582458cdd0
5027 changed files with 794942 additions and 4 deletions
|
|
@ -0,0 +1 @@
|
|||
pip
|
||||
|
|
@ -0,0 +1,110 @@
|
|||
Metadata-Version: 2.4
|
||||
Name: mcstatus
|
||||
Version: 12.0.6
|
||||
Summary: A library to query Minecraft Servers for their status and capabilities.
|
||||
Project-URL: Documentation, https://mcstatus.readthedocs.io
|
||||
Project-URL: Source code, https://github.com/py-mine/mcstatus
|
||||
Author-email: Nathan Adams <dinnerbone@dinnerbone.com>, ItsDrike <itsdrike@protonmail.com>, PerchunPak <perchunpak@gmail.com>
|
||||
Maintainer-email: Kevin Tindall <kevinkjt2000@gmail.com>, ItsDrike <itsdrike@protonmail.com>, PerchunPak <perchunpak@gmail.com>
|
||||
License-Expression: Apache-2.0
|
||||
License-File: LICENSE
|
||||
Keywords: minecraft,protocol
|
||||
Classifier: Development Status :: 5 - Production/Stable
|
||||
Classifier: Intended Audience :: Developers
|
||||
Classifier: License :: OSI Approved :: Apache Software License
|
||||
Classifier: Natural Language :: English
|
||||
Classifier: Operating System :: OS Independent
|
||||
Classifier: Programming Language :: Python
|
||||
Classifier: Programming Language :: Python :: 3
|
||||
Classifier: Programming Language :: Python :: 3.9
|
||||
Classifier: Programming Language :: Python :: 3.10
|
||||
Classifier: Programming Language :: Python :: 3.11
|
||||
Classifier: Programming Language :: Python :: 3.12
|
||||
Classifier: Programming Language :: Python :: 3.13
|
||||
Classifier: Topic :: Games/Entertainment
|
||||
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
||||
Classifier: Topic :: System :: Monitoring
|
||||
Classifier: Typing :: Typed
|
||||
Requires-Python: >=3.9
|
||||
Requires-Dist: asyncio-dgram>=2.1.2
|
||||
Requires-Dist: dnspython>=2.4.2
|
||||
Description-Content-Type: text/markdown
|
||||
|
||||
# <img src="https://i.imgur.com/nPCcxts.png" height="25" style="height: 25px"> MCStatus
|
||||
|
||||
[](https://discord.gg/C2wX7zduxC)
|
||||
|
||||
[](https://pypi.org/project/mcstatus/)
|
||||
[](https://mcstatus.readthedocs.io/)
|
||||
[](https://github.com/py-mine/mcstatus/actions/workflows/validation.yml)
|
||||
[](https://github.com/py-mine/mcstatus/actions/workflows/unit-tests.yml)
|
||||
|
||||
Mcstatus provides an API and command line script to fetch publicly available data from Minecraft servers. Specifically, mcstatus retrieves data by using these protocols: [Server List Ping](https://minecraft.wiki/w/Java_Edition_protocol/Server_List_Ping) and [Query](https://minecraft.wiki/w/Query). Because of mcstatus, you do not need to fully understand those protocols and can instead skip straight to retrieving minecraft server data quickly in your own programs.
|
||||
|
||||
## Installation
|
||||
|
||||
Mcstatus is available on [PyPI](https://pypi.org/project/mcstatus/), and can be installed trivially with:
|
||||
|
||||
```bash
|
||||
python3 -m pip install mcstatus
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Python API
|
||||
|
||||
#### Java Edition
|
||||
|
||||
```python
|
||||
from mcstatus import JavaServer
|
||||
|
||||
# You can pass the same address you'd enter into the address field in minecraft into the 'lookup' function
|
||||
# If you know the host and port, you may skip this and use JavaServer("example.org", 1234)
|
||||
server = JavaServer.lookup("example.org:1234")
|
||||
|
||||
# 'status' is supported by all Minecraft servers that are version 1.7 or higher.
|
||||
# Don't expect the player list to always be complete, because many servers run
|
||||
# plugins that hide this information or limit the number of players returned or even
|
||||
# alter this list to contain fake players for purposes of having a custom message here.
|
||||
status = server.status()
|
||||
print(f"The server has {status.players.online} player(s) online and replied in {status.latency} ms")
|
||||
|
||||
# 'ping' is supported by all Minecraft servers that are version 1.7 or higher.
|
||||
# It is included in a 'status' call, but is also exposed separate if you do not require the additional info.
|
||||
latency = server.ping()
|
||||
print(f"The server replied in {latency} ms")
|
||||
|
||||
# 'query' has to be enabled in a server's server.properties file!
|
||||
# It may give more information than a ping, such as a full player list or mod information.
|
||||
query = server.query()
|
||||
print(f"The server has the following players online: {', '.join(query.players.names)}")
|
||||
```
|
||||
|
||||
#### Bedrock Edition
|
||||
|
||||
```python
|
||||
from mcstatus import BedrockServer
|
||||
|
||||
# You can pass the same address you'd enter into the address field in minecraft into the 'lookup' function
|
||||
# If you know the host and port, you may skip this and use BedrockServer("example.org", 19132)
|
||||
server = BedrockServer.lookup("example.org:19132")
|
||||
|
||||
# 'status' is the only feature that is supported by Bedrock at this time.
|
||||
# In this case status includes players.online, latency, motd, map, gamemode, and players.max. (ex: status.gamemode)
|
||||
status = server.status()
|
||||
print(f"The server has {status.players.online} players online and replied in {status.latency} ms")
|
||||
```
|
||||
|
||||
See the [documentation](https://mcstatus.readthedocs.io) to find what you can do with our library!
|
||||
|
||||
### Command Line Interface
|
||||
|
||||
The mcstatus library includes a simple CLI. Once installed, it can be used through:
|
||||
|
||||
```bash
|
||||
python3 -m mcstatus --help
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Mcstatus is licensed under the Apache 2.0 license. See LICENSE for full text.
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
../../../bin/mcstatus,sha256=r6wzKg5C3wYDMzfeUNb06olhNZkpahJoYaWfUsRMuHg,247
|
||||
mcstatus-12.0.6.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||
mcstatus-12.0.6.dist-info/METADATA,sha256=EPTN8Ya2j4kEdJpfKrZ0XDMf4c2IzCixpPnQ-nH5xQg,5277
|
||||
mcstatus-12.0.6.dist-info/RECORD,,
|
||||
mcstatus-12.0.6.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
mcstatus-12.0.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
||||
mcstatus-12.0.6.dist-info/entry_points.txt,sha256=PARiNaGOIE04NfU3xaEkvQW3dKi35U2EreKWEu3xzLQ,52
|
||||
mcstatus-12.0.6.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
|
||||
mcstatus/__init__.py,sha256=WwTS4MoLl1IyDaHzaUUSZhyBfyFmo3yCK3McaTgsqJk,134
|
||||
mcstatus/__main__.py,sha256=rOc4ljUZbHwj_vE5yenkFkVUbCGm5shi6FHxiGGBeHw,6802
|
||||
mcstatus/__pycache__/__init__.cpython-311.pyc,,
|
||||
mcstatus/__pycache__/__main__.cpython-311.pyc,,
|
||||
mcstatus/__pycache__/address.cpython-311.pyc,,
|
||||
mcstatus/__pycache__/bedrock_status.cpython-311.pyc,,
|
||||
mcstatus/__pycache__/dns.cpython-311.pyc,,
|
||||
mcstatus/__pycache__/forge_data.cpython-311.pyc,,
|
||||
mcstatus/__pycache__/pinger.cpython-311.pyc,,
|
||||
mcstatus/__pycache__/querier.cpython-311.pyc,,
|
||||
mcstatus/__pycache__/responses.cpython-311.pyc,,
|
||||
mcstatus/__pycache__/server.cpython-311.pyc,,
|
||||
mcstatus/__pycache__/status_response.cpython-311.pyc,,
|
||||
mcstatus/__pycache__/utils.cpython-311.pyc,,
|
||||
mcstatus/address.py,sha256=oIuKg2tksusXW1ku4eEfjtbXg4-i7JSDhzxIFrR9K3k,10462
|
||||
mcstatus/bedrock_status.py,sha256=hHz1tSfV31b5_hjqtu_2Jx3bLFRz8Vxyk5u09z5mUIM,2085
|
||||
mcstatus/dns.py,sha256=8F2VYoWaAREDqIJalWW8CGGaZ-hdMTBQ4leifT78hIk,4136
|
||||
mcstatus/forge_data.py,sha256=UUrEO0xBFRbaS4zytRbqWTUD2yDcgEMF_-6G4FGlBuo,9347
|
||||
mcstatus/motd/__init__.py,sha256=wk_KgAxRtxQXi7plnEvou5xwqTZZ_bwKMyN3EEMDh8k,9103
|
||||
mcstatus/motd/__pycache__/__init__.cpython-311.pyc,,
|
||||
mcstatus/motd/__pycache__/components.cpython-311.pyc,,
|
||||
mcstatus/motd/__pycache__/simplifies.cpython-311.pyc,,
|
||||
mcstatus/motd/__pycache__/transformers.cpython-311.pyc,,
|
||||
mcstatus/motd/components.py,sha256=Z1EmW2DhI5r9lAWYhwjQfvW8it-kLIg3u0Cy3wcmkOc,3384
|
||||
mcstatus/motd/simplifies.py,sha256=M5jaS59KbAIFEYumi8XONSSx4iFg3a_sE4suZ4tyoZE,6821
|
||||
mcstatus/motd/transformers.py,sha256=9DT_HMXjwrdn9vZ0nsW8osezUYzerznU4nVtCCdvu1M,8657
|
||||
mcstatus/pinger.py,sha256=hizuSbkUyHqvpFBkSwkmloqbY3_RavleSi3oB7BZQt0,4707
|
||||
mcstatus/protocol/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
mcstatus/protocol/__pycache__/__init__.cpython-311.pyc,,
|
||||
mcstatus/protocol/__pycache__/connection.cpython-311.pyc,,
|
||||
mcstatus/protocol/connection.py,sha256=KMDMxQuSpDFvyeJRnKPiRSF-EMpJb_wweDSCuaOrn-s,25422
|
||||
mcstatus/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
mcstatus/querier.py,sha256=KkKq5ek0XUR5daYPkcf58zRYv9fOrCiTwDA8H7yfKRE,5027
|
||||
mcstatus/responses.py,sha256=2rxwSlxZm-etZN1YfkJhhqhouqY-zbKhBaXsCCHS4PU,17475
|
||||
mcstatus/server.py,sha256=Rl_rVP8oApDXWbhaiAT6hcGUBQlnlpnzQTRVnV33LBw,10153
|
||||
mcstatus/status_response.py,sha256=ETkAIPW8-M6G2bLXLiQq0vH1bNu3xyVCHXZuVTbeGfQ,793
|
||||
mcstatus/utils.py,sha256=4W7tVQd0S8X3bwvJIVfzePhmvQwx0ImBJZmodmRJYik,7018
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
Wheel-Version: 1.0
|
||||
Generator: hatchling 1.27.0
|
||||
Root-Is-Purelib: true
|
||||
Tag: py3-none-any
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
[console_scripts]
|
||||
mcstatus = mcstatus.__main__:main
|
||||
|
|
@ -0,0 +1,202 @@
|
|||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
Loading…
Add table
Add a link
Reference in a new issue