Skip to content

Commit dcbfd29

Browse files
author
osimloeff
committed
Updated README
1 parent 35f0a44 commit dcbfd29

File tree

6 files changed

+18
-8
lines changed

6 files changed

+18
-8
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@
1111

1212
# User-specific files (MonoDevelop/Xamarin Studio)
1313
*.userprefs
14+
.pypirc
1415

1516
# Build results
17+
Build/
1618
[Dd]ebug/
1719
[Dd]ebugPublic/
1820
[Rr]elease/
@@ -23,6 +25,8 @@ bld/
2325
[Bb]in/
2426
[Oo]bj/
2527
[Ll]og/
28+
osisoft.pidevclub.piwebapi.egg-info/
29+
.idea/
2630

2731
# Visual Studio 2015/2017 cache/options directory
2832
.vs/

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,12 @@ This repository has the source code package of the PI Web API client libraries f
1414

1515
If the python package is hosted on Github, you can install directly from Github
1616

17+
1718
```sh
18-
pip install git+https://github.com/osimloeff/PI-Web-API-Client-Python.git
19+
pip install osisoft.pidevclub.piwebapi
1920
```
20-
You may need to run `pip` with root permission: `sudo pip install git+https://github.com/osimloeff/PI-Web-API-Client-Python.git`. If you are using Windows, remember to open the command prompt running as administrator. You must have Git installed on your machine.
21+
22+
You may need to run `pip` with root permission: `sudo pip install osisoft.pidevclub.piwebapi`. If you are using Windows, remember to open the command prompt running as administrator. You must have Git installed on your machine.
2123

2224
Then import the package:
2325
```python
@@ -59,13 +61,13 @@ Please check the [test_main.py](/test/test_main.py) from this repository. Below
5961
#### Basic Authentication
6062
```python
6163
from osisoft.pidevclub.piwebapi.pi_web_api_client import PIWebApiClient
62-
client = PIWebApiClient("https://test.osisoft.com/piwebapi", False, "username", "password")
64+
client = PIWebApiClient("https://test.osisoft.com/piwebapi", useKerberos=False, username="username", password="password", verifySsl=true)
6365
```
6466

6567
#### Kerberos Authentication
6668
```python
6769
from osisoft.pidevclub.piwebapi.pi_web_api_client import PIWebApiClient
68-
client = PIWebApiClient("https://test.osisoft.com/piwebapi", True)
70+
client = PIWebApiClient("https://test.osisoft.com/piwebapi", useKerberos=True, verifySsl=False)
6971
```
7072

7173

296 KB
Binary file not shown.
91.9 KB
Binary file not shown.

setup.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
limitations under the License.
1616
"""
1717

18-
import sys
1918
from setuptools import setup, find_packages
2019

2120
NAME = "osisoft.pidevclub.piwebapi"
@@ -33,12 +32,17 @@
3332
name=NAME,
3433
version=VERSION,
3534
description="PI Web API client library for Python (2017 R2)",
36-
author_email="[email protected]",
37-
url="",
35+
url="https://github.com/osimloeff/PI-Web-API-Client-Python",
3836
keywords=["PI Web API"],
3937
install_requires=REQUIRES,
4038
packages=find_packages(),
4139
include_package_data=True,
40+
license='MIT',
41+
author='Marcos Vainer Loeff',
42+
author_email='[email protected]',
43+
classifiers=[
44+
'Development Status :: 5 - Production/Stable'
45+
],
4246
long_description="""\
4347
PI Web API client library for Python (2017 R2)
4448
"""

test/test_main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
class TestMain(unittest.TestCase):
3030

3131
def getPIWebApiClient(self):
32-
return PIWebApiClient("https://devdata.osisoft.com/piwebapi", False, "webapiuser", "!try3.14webapi!")
32+
return PIWebApiClient("https://devdata.osisoft.com/piwebapi", useKerberos=False, username="webapiuser", password="!try3.14webapi!", verifySsl=True)
3333

3434

3535
def test_getHome(self):

0 commit comments

Comments
 (0)