BSDCafe/checkmyip
BSDCafe/checkmyip
1
1
Fork 2
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Merge branch 'master' of https://github.com/PackeTsar/checkmyip

Browse source
This commit is contained in:
root 2017-09-05 20:27:24 +00:00
commit 2a1a04bfc3
1 changed files with 18 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,4 +1,4 @@
# [![Twitter][twitter-logo]][twitter] CheckMyIP [![CheckMyIP][logo]][twitter] # CheckMyIP (TelnetMyIP [![Twitter][twitter-logo]][twitter]) [![CheckMyIP][logo]][twitter]
A Telnet and SSH Based Public IP Address Lookup Service A Telnet and SSH Based Public IP Address Lookup Service
@ -11,8 +11,8 @@ The version of CheckMyIP documented here is: **v1.0.0**
### TABLE OF CONTENTS ### ### TABLE OF CONTENTS ###
1. [What is CheckMyIP](#what-is-checkmyip) 1. [What is CheckMyIP](#what-is-checkmyip)
2. [How to Use](#how-to-use) 2. [How to Use](#how-to-use)
3. [Install Process](#install-process) 3. [Using the API](#using-the-api)
4. [Using the API](#using-the-api) 4. [Install Process](#install-process)
5. [Contributing](#contributing) 5. [Contributing](#contributing)
@ -34,6 +34,20 @@ To enable the use of this service as a simple API, the response is formatted as
**Note:** _The DNS records for_ `telnetmyip.com` _and_ `sshmyip.com` _point to the same services._ **Note:** _The DNS records for_ `telnetmyip.com` _and_ `sshmyip.com` _point to the same services._
-----------------------------------------
### USING THE API ###
The CheckMyIP code contains the `CheckMyIP_Client` class which is an API client example which can be used to query a CheckMyIP server (like telnetmyip.com). Below is an example of how you can use it.
```
from checkmyip import CheckMyIP_Client
client = CheckMyIP_Client()
ipdict = client.get()
print("\nMy IP is %s\n" % ipdict["ip"])
print("\nI used port number %s\n" % ipdict["port"])
```
----------------------------------------- -----------------------------------------
### INSTALL PROCESS ### ### INSTALL PROCESS ###
If you would rather set up your own private instance of CheckMyIP, then you can follow the below instructions to set it up for yourself. If you would rather set up your own private instance of CheckMyIP, then you can follow the below instructions to set it up for yourself.
@ -146,26 +160,13 @@ service checkmyip status
``` ```
-----------------------------------------
### USING THE API ###
The CheckMyIP code contains the `CheckMyIP_Client` class which is an API client example which can be used to query a CheckMyIP server (like telnetmyip.com). Below is an example of how you can use it.
```
from checkmyip import CheckMyIP_Client
client = CheckMyIP_Client()
ipdict = client.get()
print("\nMy IP is %s\n" % ipdict["ip"])
print("\nI used port number %s\n" % ipdict["port"])
```
----------------------------------------- -----------------------------------------
### CONTRIBUTING ### ### CONTRIBUTING ###
If you would like to help out by contributing code or reporting issues, please do! If you would like to help out by contributing code or reporting issues, please do!
Visit the GitHub page (https://github.com/packetsar/checkmyip) and either report an issue or fork the project, commit some changes, and submit a pull request. Visit the GitHub page (https://github.com/packetsar/checkmyip) and either report an issue or fork the project, commit some changes, and submit a pull request.
[twitter-logo]: http://i.imgur.com/wWzX9uB.png [twitter-logo]: http://www.packetsar.com/wp-content/uploads/twitter-logo-35.png
[twitter]: https://twitter.com/TelnetMyIP [twitter]: https://twitter.com/TelnetMyIP
[logo]: http://www.packetsar.com/wp-content/uploads/checkmyip_icon-100.gif [logo]: http://www.packetsar.com/wp-content/uploads/checkmyip_icon-100.gif
[whatismyip]: https://www.whatismyip.com/ [whatismyip]: https://www.whatismyip.com/