README.md 595 Bytes
Newer Older
Paul Arthur's avatar
Paul Arthur committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# python-mcommunity

python-mcommunity is a Python library for interacting with the MCommunity API.

## Setting up your environment

python-mcommunity requires Python 3.

For development, we recommend using a virtualenv.

* Run `init.sh` to set up the virtualenv.
* When you want to hack on python-mcommunity, source env-setup.sh
  (`. env-setup.sh`) to set up the necessary environment variables.

## Testing

Tests can be run with `python setup.py test`.

python-mcommunity uses the [pytest](https://pytest.org/) testing framework, so
tests can also be run directly with the command `pytest`.