Jonxslays/wom.py

View on GitHub
docs/getting-started/installation.md

Summary

Maintainability
Test Coverage
# Installation

Python version 3.8 or greater is required to use wom.py.

## Stable

```sh
pip install -U wom.py
```

## Development

```sh
pip install -U git+https://github.com/Jonxslays/wom.py
```

For more information on using `pip`, check out the
[pip documentation](https://pip.pypa.io/en/stable/).

## Verify

You can verify your install succeeded with the `wom` command:

```bash
$ wom
```

The output should look similar to this:

```
-------------------------------------------------------------------------
Package:     wom.py v1.0.0-rc.1 @ [HEAD]
-------------------------------------------------------------------------
Location:    /home/projects/tester/.venv/lib/python3.11/site-packages/wom
-------------------------------------------------------------------------
Interpreter: CPython 3.11.8
-------------------------------------------------------------------------
Compiler:    GCC 13.2.1 20230801
-------------------------------------------------------------------------
OS/Arch:     Linux 6.6.22-1-lts / x86_64
-------------------------------------------------------------------------
```