Skip to content

Commit 8d10aaa

Browse files
committed
Update README
Add development and testing section.
1 parent c8d0024 commit 8d10aaa

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# pyCFClient
2-
A python client library
32

3+
A python client library for ChannelFinder. Requires python >= 3.8.
44

5-
### configuration for pyCFClient
5+
## Configuration
66

77
The python channelfinder client library can be configured by setting up a `channelfinderapi.conf` file in the following locations
88

@@ -11,6 +11,7 @@ The python channelfinder client library can be configured by setting up a `chann
1111
`channelfinderapi.conf`
1212

1313
The example preferences:
14+
1415
```
1516
cat ~/channelfinderapi.conf
1617
[DEFAULT]
@@ -19,3 +20,22 @@ username=MyUserName
1920
password=MyPassword
2021
```
2122

23+
## Development
24+
25+
To install with dependancies for testing.
26+
27+
```bash
28+
python -m pip install --upgrade pip
29+
python -m pip install '.[test]'
30+
python -m pip install .
31+
```
32+
33+
### Testing
34+
35+
Some of the tests use docker to run a test ChannelFinderService, so a working docker installation needs to available for tests to be successful.
36+
37+
To run all tests:
38+
39+
```bash
40+
python -m unittest discover -v -s test -p "test*.py"
41+
```

0 commit comments

Comments
 (0)