Skip to content

Commit 575741c

Browse files
authored
docs: installation instruction and badges (#14)
1 parent 5190616 commit 575741c

1 file changed

Lines changed: 9 additions & 18 deletions

File tree

README.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Hosting.de Client-Library [![codecov](https://codecov.io/gh/cancom/python-hostingde/branch/main/graph/badge.svg?token=C5SXI4B7PV)](https://codecov.io/gh/cancom/python-hostingde)
1+
# Hosting.de Client-Library
2+
[![codecov](https://codecov.io/gh/cancom/python-hostingde/branch/main/graph/badge.svg?token=C5SXI4B7PV)](https://codecov.io/gh/cancom/python-hostingde) [![Supported Versions](https://img.shields.io/pypi/pyversions/python-hostingde.svg)](https://pypi.org/project/python-hostingde) [![hosting.de API](https://github.com/hosting-de/awesome-hosting.de/raw/master/assets/hostingde-api.svg)](https://github.com/topics/hostingde)
3+
24

35
An unofficial client library for the [hosting.de API](https://hosting.de/api/).
46

@@ -10,21 +12,10 @@ The package requires Python 3.6+. It is currently only tested with Python 3.8, b
1012

1113
## Installation & Usage
1214

13-
The package is currently not hosted publicly, but will be initially. There is no `pip install` **yet**.
14-
15-
### Setuptools
15+
Install with pip:
1616

17-
Install via [Setuptools](http://pypi.python.org/pypi/setuptools). Clone this repository and run
18-
19-
```sh
20-
python setup.py install --user
21-
```
22-
(or `sudo python setup.py install` to install the package for all users)
23-
24-
Then import the package:
25-
26-
```python
27-
import hostingde
17+
```bash
18+
pip install python-hostingde
2819
```
2920

3021
## Getting Started
@@ -74,7 +65,7 @@ for zone in client.dns.list_zones(filter=zone_filter):
7465
print(zone)
7566
```
7667

77-
This will automatically build teh corresponding filter expression in the background
68+
This will automatically build the corresponding filter expression in the background
7869

7970
```json
8071
{
@@ -142,12 +133,12 @@ This automatically builds the equivalent filter expression for the API:
142133
}
143134
```
144135

145-
but is less verbose and more readable.
136+
which is less verbose and more readable.
146137

147138
### Error Handling
148139

149140
If the request returns an error, the error is wrapped inside a `api.client.exceptions.APIException` with all
150-
details included. You can easily catch them and react to them accodringly.
141+
details included. You can easily catch them and react to them accordingly.
151142

152143
## Current status
153144

0 commit comments

Comments
 (0)