1
1
# python-scuttle
2
2
3
3
![ 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 )
5
6
6
7
Python wrapper around [ SCUTTLE] ( https://github.com/scuttle/scuttle ) API.
7
8
8
9
## Installation
9
10
10
- With pip :
11
+ To install the latest release from PyPI :
11
12
12
- ``` python
13
- pip install - e git + https: // github.com / scuttle / python- scuttle.git
13
+ ``` shell
14
+ pip install python-scuttle
14
15
```
15
16
16
- With Pipenv :
17
+ Or, to install the latest commit to master from source :
17
18
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
20
21
```
21
22
22
23
## Usage
23
24
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.
25
27
26
28
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.
29
31
30
32
## Testing
31
33
32
- Install [ Pipenv] ( https://pypi.org/project/pipenv/ ) and install development
34
+ Install [ Pipenv] ( https://pypi.org/project/pipenv/ ) and development
33
35
dependencies:
34
36
35
37
``` shell
@@ -39,9 +41,9 @@ pipenv install --dev
39
41
Run tests in pipenv environment:
40
42
41
43
``` shell
42
- pipenv run python3 -m pytest
44
+ pipenv run pytest
43
45
```
44
46
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
47
49
Python 3.8.
0 commit comments