Skip to content

Commit e2baf6e

Browse files
committed
Update README for PyPI
1 parent 3f22e81 commit e2baf6e

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,37 @@
11
# python-scuttle
22

33
![tests](https://github.com/scuttle/python-scuttle/workflows/tests/badge.svg)
4-
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
4+
[![Code style:
5+
black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
56

67
Python wrapper around [SCUTTLE](https://github.com/scuttle/scuttle) API.
78

89
## Installation
910

10-
With pip:
11+
To install the latest release from PyPI:
1112

12-
```python
13-
pip install -e git+https://github.com/scuttle/python-scuttle.git
13+
```shell
14+
pip install python-scuttle
1415
```
1516

16-
With Pipenv:
17+
Or, to install the latest commit to master from source:
1718

18-
```python
19-
pipenv install -e git+https://github.com/scuttle/python-scuttle.git
19+
```shell
20+
pip install -e git+https://github.com/scuttle/python-scuttle.git
2021
```
2122

2223
## Usage
2324

24-
Check out the [wiki](https://github.com/scuttle/python-scuttle/wiki/API-v1).
25+
Check out the [wiki](https://github.com/scuttle/python-scuttle/wiki/API-v1) for
26+
theoretical usage and concept explanation, or the tests for live usage.
2527

2628
Current SCUTTLE API documentation can be found on [its
27-
wiki](http://scuttle.wikidot.com/api). Most methods are reproduced with similar
28-
names.
29+
wiki](http://scuttle.wikidot.com/api). As of writing, all methods are
30+
reproduced with similar names.
2931

3032
## Testing
3133

32-
Install [Pipenv](https://pypi.org/project/pipenv/) and install development
34+
Install [Pipenv](https://pypi.org/project/pipenv/) and development
3335
dependencies:
3436

3537
```shell
@@ -39,9 +41,9 @@ pipenv install --dev
3941
Run tests in pipenv environment:
4042

4143
```shell
42-
pipenv run python3 -m pytest
44+
pipenv run pytest
4345
```
4446

45-
Tests require a SCUTTLE API key with full permissions. Tests will look for this
46-
key in the `SCUTTLE_API_KEY` environment variable. Tests require at least
47+
Tests require a SCUTTLE API key with full read permissions. Tests will look for
48+
this key in the `SCUTTLE_API_KEY` environment variable. Tests require at least
4749
Python 3.8.

0 commit comments

Comments
 (0)