Added PyPI README.md

This commit is contained in:
Joseph Henry
2018-01-08 15:35:21 -08:00
parent 023a4f51da
commit 68008fc634

36
packages/pypi/README.md Normal file
View File

@@ -0,0 +1,36 @@
libzt PyPI Package
[pypi/libzt](https://pypi.python.org/pypi/libzt)
***
## Getting started
`pip3 install libzt`
```
import libzt
import time
print('joining virtual network...')
libzt.zts_startjoin('whatev_config', 0x123456789ABCDEF1)
print('fd = ' + str(libzt.zts_socket(1,2,3)))
print('looping forever, ping me')
while True:
time.sleep(1)
```
## Building the Package
Package is specified in [setup.py](setup.py). *Note: A new version must be specified in `setup.py` for every new upload of a package*
Get necessary tools
`pip3 install wheel twine`
Build the binary distribution wheel:
`python3 setup.py bdist_wheel`
Upload to PyPI
`twine upload dist/*`