https://github.com/ibmstreams/pypi.streamsx.geospatial
A project to allow natural use of Streams for a Python developer. It will be registered with PyPi to allow 'pip install' of Python packages that support Python developers interacting with IBM Streams.
https://github.com/ibmstreams/pypi.streamsx.geospatial
pypi python python-packages
Last synced: 10 months ago
JSON representation
A project to allow natural use of Streams for a Python developer. It will be registered with PyPi to allow 'pip install' of Python packages that support Python developers interacting with IBM Streams.
- Host: GitHub
- URL: https://github.com/ibmstreams/pypi.streamsx.geospatial
- Owner: IBMStreams
- License: apache-2.0
- Created: 2019-11-14T12:31:06.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2020-12-07T08:07:13.000Z (over 5 years ago)
- Last Synced: 2025-03-17T09:22:35.247Z (about 1 year ago)
- Topics: pypi, python, python-packages
- Language: Python
- Homepage: https://ibmstreams.github.io/pypi.streamsx.geospatial/
- Size: 125 KB
- Stars: 0
- Watchers: 10
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Python streamsx.geospatial package
This exposes SPL operators in the `com.ibm.streamsx.geospatial` 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.geospatial
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:
* http://streamsxgeospatial.readthedocs.io
## Version update
To change the version information of the Python package, edit following files:
- ./package/docs/source/conf.py
- ./package/streamsx/geospatial/\_\_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/geospatial/\_\_init\_\_.py
- ./package/DESC.txt
## Environment
You need the streamsx package in version 1.13.15 to use and test the streamsx.geospatial package. Install it like this:
pip install streamsx==1.13.15
In addition you should unset the PYTHONPATH variable to not use the streams package included in your local Streams installation:
unset PYTHONPATH
## Test
When using local build (e.g. not forcing remote build), then you need to specifiy the toolkit location, for example:
export STREAMSX_GEOSPATIAL_TOOLKIT=/com.ibm.streamsx.geospatial
### Build only test
Run the test with:
ant test-build-only
```
cd package
python3 -u -m unittest streamsx.geospatial.tests.test_regionmatch.Test
```
### Distributed test
Make sure that the streams environment is set and the environment variables:
STREAMS_INSTALL, STREAMS_DOMAIN_ID, and STREAMS_INSTANCE_ID are setup.
Run the test with:
ant test
or
```
cd package
python3 -u -m unittest streamsx.geospatial.tests.test_regionmatch.TestDistributed
```
### Streaming Analytics service
Package can be tested with TopologyTester using the [Streaming Analytics](https://www.ibm.com/cloud/streaming-analytics) service.
Run the test with:
ant test-sas
or
```
cd package
python3 -u -m unittest streamsx.geospatial.tests.test_regionmatch.TestStreamingAnalytics
```