Myr (Pauperformance bot)

This repository hosts Myr, the bot required to manage the Pauperformance project.

Myr tirelessly takes care of different tasks. The most important of them is keeping the Academy up-to-date.

Information

Status: Actively developed

Type: Personal project

Development year(s): 2021+

Authors: ShadowTemplate, ThisIsMirquez, Federico Maiorano, Rikxvis, Marco Casari

Getting Started

Make sure Python 3.8 (or newer) is installed on your machine. Instructions to download and install Python can be found in the official page.
You can verify Python is working by running:

$ python3 --version
Python 3.8.10

Additionally, install pip and venv modules.
You can verify pip is working by running:

$ pip --version
pip 20.0.2 from /usr/lib/python3/dist-packages/pip (python 3.8)

Make sure git is also installed on your machine. Instructions to download and install git can be found in the official page.
You can verify git is working by running:

$ git --version
git version 2.25.1

Now, you are ready to clone Pauperformance repositories (you will need both of them):

$ git clone https://github.com/Pauperformance/Pauperformance.github.io.git
$ git clone https://github.com/Pauperformance/pauperformance-bot.git
$ cd pauperformance-bot

Prerequisites

Create and activate a virtual environment for Myr:

$ python3 -m venv venv
$ source venv/bin/activate
$ pip install --upgrade pip setuptools wheel

Installing

Upon installing Myr in your virtual environment, you can choose between 3 versions:

default: sufficient to execute Myr tasks;
test: required to run Myr tests, often used by autonomous agents (includes default);
dev: required to develop new Myr functionalities (includes default).

You can install any of these versions by running, respectively:

$ pip install .        # default
$ pip install .[test]  # test
$ pip install .[dev]   # dev

You can verify pauperformance-bot is working by running:

$ myr test hello
Myr ready to serve you, Milord!

Testing

Tests are executed with tox:

$ tox

Building tools

Python - Programming language
GitHub Pages - Web host
Jinja - Templating engine
Dropbox - Storage service
pyquery - Web pages parser

Contributing

Any contribution is welcome. Please read CONTRIBUTING.md for details on how to submit pull requests.

License

This project is licensed under the GNU General Public License v3 (GPLv3) license. Please refer to the LICENSE.md file for details.

This README.md complies with this project template. Feel free to adopt it and reuse it.

PotHix / pauperformance-bot