Skip to content

Latest commit

 

History

History
66 lines (55 loc) · 2.56 KB

README.md

File metadata and controls

66 lines (55 loc) · 2.56 KB

DevEx SDK

Installing devex_sdk from PyPi (Latest Release):

pip install devex-sdk

or

pip install git+https://github.com/DISHDevEx/dish-devex-sdk.git

Installing devex_sdk from local build (beta testing):

  1. Navigate into the root devex_sdk directory.
cd dish-devex-sdk
  1. Run the following command to create the wheel file
python setup.py bdist_wheel --version <VERSION_NUMBER>

NOTE: the <VERSION_NUMBER> only effects your local build. You can use any version number you like. This can be helpful in testing prior to submitting a pull request. Alternatively, you can eclude the --version <VERSION_NUMBER> flag and the .whl file name will output as devex_sdk-VERSION_PLACEHOLDER-py3-none-any.whl

  1. Next, pip install the wheel file by running the following command, note that the version will change depending upon the release:
pip install /dist/devex_sdk-<VERSION_NUMBER>-py3-none-any.whl

Usage

Once complete, devex_sdk will be available in your Python evironment for use. Enter your Python environment and import devex_sdk as you would with any other library or package.

>>> import devex_sdk

All functions contained in devex_sdk available for use can be listed by listing the package directory structure:

>>> dir(devex_sdk)

The package and included functions can then be used like any other Python library. Functions can be used via dot notation with the specified packages:

>>> devex_sdk.multiply(2,3)
6

Alternatively, you can import all algorithms from the devex_sdk library and use each without the use of dot notation:

>>> from devex_sdk import *
>>> multiply(2,3)
6

History

View version history and release notes in HISTORY.

Contributing

Learn how about CONTRIBUTING to devex_sdk.

Releases on GitHub

View all DevEx SDK releases on GitHub.

Releases on PyPi

View all DevEx SDK release history on PyPi.

Python Packages in DevEx SDK