/pypi.streamsx.pmml

[INCUBATION] This is a step in allowing natural use of Streams for a Python developer. A project that will be registered with PyPi to allow 'pip install' of Python packages that support Python developers interacting with IBM Streams.

Primary LanguagePythonApache License 2.0Apache-2.0

Python streamsx.pmml package

This exposes SPL operators in the com.ibm.streams.pmml toolkit as Python methods.

Package is organized using standard packaging to upload to PyPi.

The package is uploaded to PyPi in the standard way:

cd package
python setup.py sdist bdist_wheel upload -r pypi

Note: This is done using the ibmstreams account at pypi.org and requires .pypirc file containing the credentials in your home directory.

Package details: https://pypi.python.org/pypi/streamsx.pmml

Documentation is using Sphinx and can be built locally using:

cd package/docs
make html

or

ant doc

and viewed using

firefox package/docs/build/html/index.html

The documentation is also setup at readthedocs.io.

Documentation links:

Version update

To change the version information of the Python package, edit following files:

  • ./package/docs/source/conf.py
  • ./package/streamsx/pmml/__init__.py

When the development status changes, edit the classifiers in

  • ./package/setup.py

When the documented sample must be changed, change it here:

  • ./package/streamsx/pmml/__init__.py
  • ./package/DESC.txt

Test

Package can be tested with TopologyTester.

It is required to specify the pmml toolkit location with the environment variable: PMML_TOOLKIT_HOME

Launch the test cases for build only verification (streamsx.topology.context.ContextTypes: TOOLKIT and BUNDLE):

cd package
python3 -u -m unittest streamsx.pmml.tests.test_pmml.Test

or

ant test