# fetch-paper-api

**Repository Path**: ruofengx/fetch-paper-api

## Basic Information

- **Project Name**: fetch-paper-api
- **Description**: 爬取papermc.io的文件下载api地址的python脚本
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-11
- **Last Updated**: 2022-06-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# fetch-paper-api
It is a simple python script to download jar file from papermc.io/api/v2 with customable project(paper, velocity, etc.) and version(1.18.1, 3.1.1, etc.)
## Brief Guide
### Requirements
- python3
- modules listed in requirements.txt, use `pip install -r requirements.txt` to install all of them

### Example(TL;NR)  
> I want to download build 100 of papermc 1.18.1, using:  
`python main.py paper 1.18.1 -b 100`

> I want to download latest build of velocity 3.1.1, using:  
`python main.py velocity 3.1.1`

### Usage
```
usage: main.py [-h] [-b BUILD] project version

Fetch latest build from paper.io/api/v2, and check them with SHA256.

positional arguments:
  project               choice which project should use.
  version               choice which version should use

optional arguments:
  -h, --help            show this help message and exit
  -b BUILD, --build BUILD
                        build number, leave blank to fetch latest.

```

## Docker Example
Please refer to Dockerfile in this repository.