Added PyPI README.md
This commit is contained in:
36
packages/pypi/README.md
Normal file
36
packages/pypi/README.md
Normal 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/*`
|
||||||
Reference in New Issue
Block a user