Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 1.32 KB

README.md

File metadata and controls

49 lines (31 loc) · 1.32 KB

jo_serv

JO server source code

Development Quickstart

A quickstart guide/cheatsheet is available here, that lists the useful commands when developing this package.

Installation

The two following methods will install this project as an executable callable directly from your terminal.

Note that you should ideally run these pip commands in an active virtualenv, and not in your system Python install.

From a release archive

To install jo_serv, download the latest release archive fom Github, and run this command in your terminal:

pip install jo_serv-1.0.0-py3-none-any.whl
# or
pip install jo_serv-1.0.0.tar.gz

From sources

The sources for jo_serv can be downloaded from the Github repo.

Start by cloning the repository:

git clone [email protected]:pcurt/jo_serv.git

Then enter the cloned directory (with cd jo_serv/), and install the project with:

pip install .

Usage

Describe here how to use this Python package: CLI options and flags, API when imported by another package, etc.