Skip to content

Commit 54d1359

Browse files
author
Marcel Hecko
committed
change the name of the class
1 parent 1c15ae8 commit 54d1359

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
1+
# pySigfox
2+
13
Trivial Python class to be used with Sigfox backend http API.
24

5+
Username and password is not the same as the credential you use to access Sigfox backend!
6+
To get the API access credentials, log into Sigfox backend, then go to Groups -> select group -> API ACCESS.
7+
Then click on 'new' and create new access entry.
8+
9+
## Detail info
10+
311
Author: Marcel Hecko [email protected]
412

5-
Run example like this (use your own API username and password):
13+
## Example of use
14+
15+
Run example like this (use your own API username and password) from (Linux / Mac...) terminal:
616

717
SIGFOX_API_LOGIN='5787d7bf3cxxx9106c93c795' SIGFOX_API_PASSWORD='b8faf16exxx11dd1bb1789cb25028e3b' ./example.py
818

9-
Username and password is not the same as the credential you use to access Sigfox backend!
10-
To get the API access credentials, log into Sigfox backend, then go to Groups -> select group -> API ACCESS.
11-
Then click on 'new' and create new access entry.
19+
## Full documentation
20+
21+
http://pysigfox.readthedocs.io

example.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
login = os.getenv('SIGFOX_LOGIN')
1010
password = os.getenv('SIGFOX_PASSWORD')
1111

12-
s = pySigfox.pySigfox(login, password)
12+
s = pySigfox.Sigfox(login, password)
1313

1414
try:
1515
s.login_test()

pySigfox/pySigfox.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import requests
77
from pprint import pprint
88

9-
class pySigfox:
9+
class Sigfox:
1010
def __init__(self, login, password):
1111
if not login or not password:
1212
raise Exception("Please define login and password when initiating pySigfox class!")

0 commit comments

Comments
 (0)