Python SDK for Pinggy

Step by step procedure to build .whl files for Pinggy, depending on different OS & Architecture.

Looking for usage docs? See PyPI_Description.md for a quick start and API_DOC.md for the full API reference.

📁 Directory Structure

pinggy/
├── __init__.py
├── __main__.py
├── __version__.py
├── core.py            # ctypes bindings for libpinggy
├── loader.py          # native library loader
├── pinggyexception.py # SDK exceptions
└── pylib.py           # high-level Tunnel / BaseTunnelHandler API
setup.py
generate_docs.py
syncVersionWithTag.py

🛠️ Requirements

• Python 3.6+
• wheel and setuptools

   pip install wheel setuptools requests

• Shared libraries (.so, .dll, .dylib) hosted on an HTTP server. However, they are packaged in zip/tgz along with dependencies. Zips/tgzs are categories by os and architectures.

  List of Zip files

  • libpinggy-{version}-ssl-linux-aarch64.tgz
  • libpinggy-{version}-ssl-linux-armv7.tgz
  • libpinggy-{version}-ssl-linux-i686.tgz
  • libpinggy-{version}-ssl-linux-x86_64.tgz
  • libpinggy-{version}-ssl-macos-universal.tgz
  • libpinggy-{version}-windows-aarch64-MT.zip
  • libpinggy-{version}-windows-armv7-MT.zip
  • libpinggy-{version}-windows-i686-MT.zip
  • libpinggy-{version}-windows-x86_64-MT.zip
• Linux and Macosx need explicit OpenSSL libs which is present at openssl/lib dir
• Linux system for building all platform wheels (cross-platform)

🔧 Environment Setup

Set the environment variable for the shared library server:

export LIB_PINGGY_SERVER=http://lib_pinggy_server.com/

Example Usage

python setup.py bdist_wheel --plat-name=win-amd64

python setup.py bdist_wheel --plat-name=linux-x86_64

python setup.py bdist_wheel --plat-name=macosx-universal

pip install .

Names

Wheel filenames follow the pattern pinggy-{version}-cp310-abi3-{plat_tag}.whl:

PlatKey	Wheel	Desc
macosx-universal	pinggy-0.1.0-cp310-abi3-macosx_11_0_universal2.whl
linux-aarch64	pinggy-0.1.0-cp310-abi3-manylinux_2_28_aarch64.whl
linux-arm7l	pinggy-0.1.0-cp310-abi3-manylinux_2_28_armv7l.whl
linux-i686	pinggy-0.1.0-cp310-abi3-manylinux_2_28_i686.whl
linux-x86_64	pinggy-0.1.0-cp310-abi3-manylinux_2_28_x86_64.whl
win-amd64	pinggy-0.1.0-cp310-abi3-win_amd64.whl
win-arm64	pinggy-0.1.0-cp310-abi3-win_arm64.whl
win32	pinggy-0.1.0-cp310-abi3-win32.whl

License

LICENSE