# serverjars-api
[](https://pypi.org/project/serverjars-api/)
[](https://www.python.org/downloads//)
[](https://github.com/legopitstop/serverjars-py/issues)
[](https://github.com/ambv/black)
Download and fetch details about Minecraft server jars.
## Installation
Install the module with pip:
```bat
pip3 install serverjars-api
```
Update existing installation: `pip3 install serverjars-api --upgrade`
## Features
- Access vanilla or modded Minecraft jars.
- No 3rd party APIs.
- Add support for your own jar service.
## Links
- [Documentation](https://docs.lpsmods.dev/serverjars-api)
- [Source Code](https://github.com/legopitstop/serverjars-py)
## Dependencies
| Name | Description |
| ---------------------------------------------- | ------------------------------------------------ |
| [requests](https://pypi.org/project/requests/) | Requests is a simple, yet elegant, HTTP library. |
| [pydantic](https://pypi.org/project/pydantic/) | Data validation using Python type hints |
## Code Examples:
Fetching the latest jar:
```python
import serverjars
latest = serverjars.fetch_latest('vanilla', 'release')
print(latest)
```
Fetching all the Jars:
```python
import serverjars
allJars = serverjars.fetch_all('vanilla', 'snapshot')
print(allJars)
```
Fetching types:
```python
import serverjars
subtypes = serverjars.fetch_types('modded')
print(subtypes)
```
Downloading Jars:
```python
import serverjars
serverjars.download_jar('vanilla', "release")
```
Create and run a Minecraft server
```python
import serverjars
app = serverjars.App.create('vanilla', "release", fp="svr/server.jar")
app.run()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/legopitstop/serverjars-py/",
"name": "serverjars-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ServerJars, Minecraft, Servers, Bedrock, API",
"author": "Legopitstop",
"author_email": "contact@lpsmods.dev",
"download_url": "https://files.pythonhosted.org/packages/2d/9f/7867066483f641ec42efffbe23ef09f0ef752ff6252e3ad746eb10b90e8f/serverjars-api-1.4.0.tar.gz",
"platform": null,
"description": "# serverjars-api\n\n\n[](https://pypi.org/project/serverjars-api/)\n[](https://www.python.org/downloads//)\n\n\n[](https://github.com/legopitstop/serverjars-py/issues)\n[](https://github.com/ambv/black)\n\nDownload and fetch details about Minecraft server jars.\n\n## Installation\nInstall the module with pip:\n```bat\npip3 install serverjars-api\n```\nUpdate existing installation: `pip3 install serverjars-api --upgrade`\n\n## Features\n\n- Access vanilla or modded Minecraft jars. \n- No 3rd party APIs. \n- Add support for your own jar service. \n\n## Links\n\n- [Documentation](https://docs.lpsmods.dev/serverjars-api)\n- [Source Code](https://github.com/legopitstop/serverjars-py)\n\n## Dependencies\n\n| Name | Description |\n| ---------------------------------------------- | ------------------------------------------------ |\n| [requests](https://pypi.org/project/requests/) | Requests is a simple, yet elegant, HTTP library. |\n| [pydantic](https://pypi.org/project/pydantic/) | Data validation using Python type hints |\n\n## Code Examples:\nFetching the latest jar:\n```python\nimport serverjars\nlatest = serverjars.fetch_latest('vanilla', 'release')\nprint(latest)\n```\n\nFetching all the Jars:\n```python\nimport serverjars\nallJars = serverjars.fetch_all('vanilla', 'snapshot')\nprint(allJars)\n```\n\nFetching types:\n```python\nimport serverjars\nsubtypes = serverjars.fetch_types('modded')\nprint(subtypes)\n```\n\nDownloading Jars:\n```python\nimport serverjars\n\nserverjars.download_jar('vanilla', \"release\")\n```\n\nCreate and run a Minecraft server\n```python\nimport serverjars\n\napp = serverjars.App.create('vanilla', \"release\", fp=\"svr/server.jar\")\napp.run()\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Download and fetch details about Minecraft server jars.",
"version": "1.4.0",
"project_urls": {
"Documentation": "https://docs.lpsmods.dev/serverjars-api",
"Download": "https://github.com/legopitstop/serverjars-py/releases",
"Homepage": "https://github.com/legopitstop/serverjars-py/",
"Source Code": "https://github.com/legopitstop/serverjars-py"
},
"split_keywords": [
"serverjars",
" minecraft",
" servers",
" bedrock",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d9f7867066483f641ec42efffbe23ef09f0ef752ff6252e3ad746eb10b90e8f",
"md5": "a45da45ee1e4ac8c856f3ff9ffda6f9a",
"sha256": "f75321fbb7d8339da8d9c635f531f7cb8c96ae8a697015a83975a73cbe885cfe"
},
"downloads": -1,
"filename": "serverjars-api-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "a45da45ee1e4ac8c856f3ff9ffda6f9a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7820,
"upload_time": "2024-07-01T02:03:29",
"upload_time_iso_8601": "2024-07-01T02:03:29.129690Z",
"url": "https://files.pythonhosted.org/packages/2d/9f/7867066483f641ec42efffbe23ef09f0ef752ff6252e3ad746eb10b90e8f/serverjars-api-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-01 02:03:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "legopitstop",
"github_project": "serverjars-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "serverjars-api"
}
JSON
