ols

command module
v0.3.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 13, 2022 License: MIT Imports: 1 Imported by: 0

README

About The Project

OLS (OL scraper) is a webscraper written in golang which is meant to fetch data from the football manager browser game Onlineliga.

Currently capable of scraping:

  • league
  • team
  • player
  • match (WIP)

Currently supported targets:

intro

Table of Contents

Built With

Getting Started

The scraper fetches data and saves the output by default into a JSON file at the exact same directory where the application is executed.

Additionally it can analyze OL teams according to Boonlight's Excel sheets and dump the result into a CSV file.

Disclaimer

❗ Disclaimer
Scraping and analyzing this game is not allowed by Terms of Service.
ToS

Quickstart

Install the OL scraper and open the help menu

go install gitlab.com/onlineliga/ols@latest
ols --help

Prerequisites

Optional:

Installation

There are two options to run the application. Either by using golang or the compiled binaries which you can find under releases.

You can install the application with golang specifying a release.

go install gitlab.com/onlineliga/ols@v?.?.?

To install the latest version use @latest. Works on every platform.

Install binaries

Following examples will install latest version

Windows Powershell

installation with Powershell:

  • create directory and remove curl alias
    mkdir $HOME\ols\
    Remove-Item alias:curl
    
  • fetch latest tag and download binaries
    $JSON = curl -s https://gitlab.com/api/v4/projects/31154129/repository/tags | ConvertFrom-Json
    $TAG = $JSON[0].name
    curl -o $HOME\ols\ols.exe -L https://gitlab.com/onlineliga/ols/-/jobs/artifacts/$TAG/raw/binaries/ols-windows-amd64.exe?job=build-release
    
Bash

installation with bash:

  • create directory
    mkdir -p ~/.local/bin/
    
  • fetch latest tag and download binaries
    TAG=$(curl -s  https://gitlab.com/api/v4/projects/31154129/repository/tags | jq -r .[0].name)
    curl -o ~/.local/bin/ols -L https://gitlab.com/onlineliga/ols/-/jobs/artifacts/${TAG}/raw/binaries/ols-linux-amd64?job=build-release
    
  • make binaries executable
    chmod +x ~/.local/bin/ols
    

Note: in the Downloads section you can find binaries for all available platforms

Downloads

OLS is crosscompiled for

Usage

Windows

Add the application directory to your PATH environment variable so you can call it from anywhere.

Note: In order to make it persistent visit Microsoft docs.

Now you can use the application like this:

ols --help

Linux

ols --help

Examples

Powershell examples

Contributing

Contact

Community Discord server

Documentation

Overview

Copyright © 2021 tripleawwy

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.

Directories

Path Synopsis
internal
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL