eguivalet-server 0.2.1
A server implementation for the EguiValet messaging service.
License: MIT
Requires Python: >=3.8,<4.0
Keywords: api,communication,network,networking,python3,restful

# 5G00EV25-3001 Server

A server implementation for the EguiValet messaging service.

|              |   |
|--------------|---|
| Tests (main) | [![codecov](https://codecov.io/gh/Diapolo10/5G00EV25-3001_server/branch/main/graph/badge.svg?token=zBlgCd32Aq)](https://codecov.io/gh/Diapolo10/5G00EV25-3001_server) ![Unit tests](https://github.com/diapolo10/5G00EV25-3001_server/workflows/Unit%20tests/badge.svg) ![Pylint](https://github.com/diapolo10/5G00EV25-3001_server/workflows/Pylint/badge.svg) ![Flake8](https://github.com/diapolo10/5G00EV25-3001_server/workflows/Flake8/badge.svg) |
| Activity     | ![GitHub contributors](https://img.shields.io/github/contributors/diapolo10/5G00EV25-3001_server) ![Last commit](https://img.shields.io/github/last-commit/diapolo10/5G00EV25-3001_server?logo=github) ![GitHub all releases](https://img.shields.io/github/downloads/diapolo10/5G00EV25-3001_server/total?logo=github) ![GitHub issues](https://img.shields.io/github/issues/diapolo10/5G00EV25-3001_server) ![GitHub closed issues](https://img.shields.io/github/issues-closed/diapolo10/5G00EV25-3001_server) ![GitHub pull requests](https://img.shields.io/github/issues-pr/diapolo10/5G00EV25-3001_server) ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/diapolo10/5G00EV25-3001_server) |
| QA           | [![CodeFactor](https://www.codefactor.io/repository/github/diapolo10/5G00EV25-3001_server/badge?logo=codefactor)](https://www.codefactor.io/repository/github/diapolo10/5G00EV25-3001_server) |
| Other        | [![License](https://img.shields.io/github/license/diapolo10/5G00EV25-3001_server)](https://opensource.org/licenses/MIT) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FDiapolo10%2F5G00EV25-3001_server.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FDiapolo10%2F5G00EV25-3001_server?ref=badge_shield) [![Requirements Status](https://requires.io/github/Diapolo10/5G00EV25-3001_server/requirements.svg?branch=main)](https://requires.io/github/Diapolo10/5G00EV25-3001_server/requirements/?branch=main) ![Repository size](https://img.shields.io/github/repo-size/diapolo10/5G00EV25-3001_server?logo=github) ![Code size](https://img.shields.io/github/languages/code-size/diapolo10/5G00EV25-3001_server?logo=github) ![Lines of code](https://img.shields.io/tokei/lines/github/diapolo10/5G00EV25-3001_server?logo=github) |

## Installation

The package is currently not available on PyPI.

To run the project, download the repository. You will need to have Python 3.8
or newer installed, as well as Poetry.

```sh
pip install poetry
```

Unzip the project files, and navigate to the project directory. Run the commands

```sh
poetry shell
poetry install
```

in order to create a virtual environment for the project and install its
dependencies.

You can then run the project by running `eguivalet_server/main.py` while within the
virtual environment.

<!-- markdownlint-configure-file {
    "MD013": false
} -->
<!--
    MD013: Line length
-->