https://github.com/legopitstop/serverjars-py

The unofficial Python wrapper for serverjars.com
https://github.com/legopitstop/serverjars-py

api bedrock java minecraft pypi python pythonpackage serverjars servers

Last synced: about 2 months ago
JSON representation

The unofficial Python wrapper for serverjars.com

• Host: GitHub
• URL: https://github.com/legopitstop/serverjars-py
• Owner: legopitstop
• License: mit
• Created: 2022-09-05T23:11:44.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T17:52:46.000Z (9 months ago)
• Last Synced: 2024-04-11T22:27:04.537Z (9 months ago)
• Topics: api, bedrock, java, minecraft, pypi, python, pythonpackage, serverjars, servers
• Language: Python
• Homepage: https://pypi.org/project/serverjars-api/
• Size: 48.8 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# serverjars-api

![Tests](https://github.com/legopitstop/serverjars-py/actions/workflows/tests.yml/badge.svg)

[![PyPI](https://img.shields.io/pypi/v/serverjars-api)](https://pypi.org/project/serverjars-api/)

[![Python](https://img.shields.io/pypi/pyversions/serverjars-api)](https://www.python.org/downloads//)

![Downloads](https://img.shields.io/pypi/dm/serverjars-api)

![Status](https://img.shields.io/pypi/status/serverjars-api)

[![Issues](https://img.shields.io/github/issues/legopitstop/serverjars-py)](https://github.com/legopitstop/serverjars-py/issues)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](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()

```