-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* update links to this project on GitHub to current namespace (`1and1` => `ionos-cloud`) * dimclient: reference public OBS and PyPI * ndcli: reference public OBS and PyPI * fix according to markdown linting complaints * .gitignore: add pyproject.toml build dirs
- Loading branch information
1 parent
c775fa9
commit bcafc51
Showing
9 changed files
with
78 additions
and
116 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,26 @@ | ||
dimclient | ||
========= | ||
# dimclient | ||
|
||
`dimclient` is a python client library to talk to dim. It provides a method | ||
method interface to all DIM functions. | ||
`dimclient` is a Python client library to talk to DIM. It provides a method | ||
interface to all DIM functions. | ||
|
||
usage | ||
----- | ||
## usage | ||
|
||
To use dimclient, install dimclient in your python environment. | ||
To use `dimclient`, install it in your Python environment. | ||
|
||
There are two options to do that: | ||
|
||
1. *Distribution packages:* Download and install a distribution-packaged package. There are | ||
packages for Debian- and Redhat-based distributions | ||
in dimclient specific [releases](https://github.com/1and1/dim/releases). | ||
1. *Distribution packages:* Download and install a distribution-packaged package. There are packages for Linux distributions available at [openSUSE Build Service - home:zeromind:dim/dimclient](https://build.opensuse.org/package/show/home:zeromind:dim/dimclient). | ||
Note that distribution packages install the dimclient globally. | ||
2. *Python PIP:* There's no PyPI repo yet, but you can add a specific git tag from | ||
the github repo towards your requirements.txt file so PIP can download and | ||
install dimclient, i.e. in a virtual environment. | ||
A sample requirements.txt snippet is given in the following example: | ||
2. *Python PIP:* [PyPI dimclient](https://pypi.org/project/dimclient/) | ||
|
||
```sh | ||
pip install dimclient | ||
``` | ||
git+https://github.com/1and1/[email protected]#egg=dimclient&subdirectory=dimclient | ||
``` | ||
|
||
|
||
In your script, create a new dim client and log into the instance. After that, | ||
you can make any request. | ||
In your script, create a new DIM client and log into the instance. | ||
After that, you can make any request. | ||
|
||
``` | ||
```python | ||
import dimclient | ||
|
||
client = dimclient.DimClient("http://localhost:8080") | ||
|
Oops, something went wrong.