ibmpairs


Nameibmpairs JSON
Version 3.1.7 PyPI version JSON
download
home_pagehttps://ibm.github.io/ibmpairs/
Summaryopen source Python modules for the IBM Environmental Intelligence Geospatial APIs platform
upload_time2025-01-27 13:33:47
maintainertaylorsteffanj
docs_urlNone
authorEnvironmental Intelligence, IBM Software
requires_pythonNone
licenseBSD-Clause-3
keywords ibm environmental intelligence geospatial apis geospatial analytics pairs gis biggeodata
VCS
bugtrack_url
requirements aiohttp fs future geojson ibm_cos_sdk jsonschema numpy pandas Pillow polling pytz rasterio Requests Shapely tableschema
Travis-CI
coveralls test coverage No coveralls.
            # IBM Environmental Intelligence (EI): Geospatial APIs SDK

[![PyPI Package](https://badge.fury.io/py/ibmpairs.svg)](https://pypi.org/project/ibmpairs/)

This repository provides an interface to the IBM EI: Geospatial APIs component:
[IBM EI: Geospatial APIs](https://www.ibm.com/products/environmental-intelligence).

E.g. the `query` module in the subdirectory `ibmpairs` serves as a wrapper employing the IBM EI: 
Geospatial APIs served through the RESTful host reachable via
[https://api.ibm.com/geospatial/run/na/core/v3/](https://developer.ibm.com/apis/catalog/envintelsuite--ibm-environmental-intelligence).

Sample applications that use `ibmpairs` can be located in the [Environmental-Intelligence](https://github.com/IBM/Environmental-Intelligence/tree/main) project.


# General Notes

If you like to contribute, please read [CONTRIBUTING.md](https://github.com/ibm/ibmpairs/blob/master/CONTRIBUTING.md)
first. A list of maintainers is recorded in [MAINTAINERS.md](https://github.com/ibm/ibmpairs/blob/master/MAINTAINERS.md).


# Installation and Usage

If you have installed the Python package manager [PIP](https://github.com/pypa/pip),
simply run
```Bash
pip install --user ibmpairs
```
Then you can import the IBM EI: Geospatial APIs SDK wrapper modules e.g.:
```Python
import ibmpairs.client as client
import ibmpairs.query as query
```


# Getting started

See the documentation [here](https://ibm.github.io/ibmpairs/) and try our tutorials.


# Running in a Docker container

A self-contained environment can be built with [Docker](http://www.docker.com) using
```Bash
git clone https://github.com/ibm/ibmpairs
cd ibmpairs
make docker-build
```
then run using:
```Bash
make docker-run
```
the environment can then be accessed from the following url:
```
http://localhost:18380
```

Alternatively you can execute these steps without Make using:
```Bash
git clone https://github.com/ibm/ibmpairs
cd ibmpairs
docker build -t ibmpairs .
```
to build and
```Bash
docker run \
    -dit \
    -p 18380:18380 \
    --name ibmpairs \
    ibmpairs:latest
```
or:
```Bash
docker-compose up ibmpairs
```
to run.

            

Raw data

            {
    "_id": null,
    "home_page": "https://ibm.github.io/ibmpairs/",
    "name": "ibmpairs",
    "maintainer": "taylorsteffanj",
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "IBM Environmental Intelligence Geospatial APIs Geospatial Analytics PAIRS GIS BigGeoData",
    "author": "Environmental Intelligence, IBM Software",
    "author_email": "pairs@us.ibm.com",
    "download_url": "https://files.pythonhosted.org/packages/05/b6/98deb535c59e9c812321800a9a7b721a04dc1ea9bd37f39d06e86b9f4d8a/ibmpairs-3.1.7.tar.gz",
    "platform": null,
    "description": "# IBM Environmental Intelligence (EI): Geospatial APIs SDK\n\n[![PyPI Package](https://badge.fury.io/py/ibmpairs.svg)](https://pypi.org/project/ibmpairs/)\n\nThis repository provides an interface to the IBM EI: Geospatial APIs component:\n[IBM EI: Geospatial APIs](https://www.ibm.com/products/environmental-intelligence).\n\nE.g. the `query` module in the subdirectory `ibmpairs` serves as a wrapper employing the IBM EI: \nGeospatial APIs served through the RESTful host reachable via\n[https://api.ibm.com/geospatial/run/na/core/v3/](https://developer.ibm.com/apis/catalog/envintelsuite--ibm-environmental-intelligence).\n\nSample applications that use `ibmpairs` can be located in the [Environmental-Intelligence](https://github.com/IBM/Environmental-Intelligence/tree/main) project.\n\n\n# General Notes\n\nIf you like to contribute, please read [CONTRIBUTING.md](https://github.com/ibm/ibmpairs/blob/master/CONTRIBUTING.md)\nfirst. A list of maintainers is recorded in [MAINTAINERS.md](https://github.com/ibm/ibmpairs/blob/master/MAINTAINERS.md).\n\n\n# Installation and Usage\n\nIf you have installed the Python package manager [PIP](https://github.com/pypa/pip),\nsimply run\n```Bash\npip install --user ibmpairs\n```\nThen you can import the IBM EI: Geospatial APIs SDK wrapper modules e.g.:\n```Python\nimport ibmpairs.client as client\nimport ibmpairs.query as query\n```\n\n\n# Getting started\n\nSee the documentation [here](https://ibm.github.io/ibmpairs/) and try our tutorials.\n\n\n# Running in a Docker container\n\nA self-contained environment can be built with [Docker](http://www.docker.com) using\n```Bash\ngit clone https://github.com/ibm/ibmpairs\ncd ibmpairs\nmake docker-build\n```\nthen run using:\n```Bash\nmake docker-run\n```\nthe environment can then be accessed from the following url:\n```\nhttp://localhost:18380\n```\n\nAlternatively you can execute these steps without Make using:\n```Bash\ngit clone https://github.com/ibm/ibmpairs\ncd ibmpairs\ndocker build -t ibmpairs .\n```\nto build and\n```Bash\ndocker run \\\n    -dit \\\n    -p 18380:18380 \\\n    --name ibmpairs \\\n    ibmpairs:latest\n```\nor:\n```Bash\ndocker-compose up ibmpairs\n```\nto run.\n",
    "bugtrack_url": null,
    "license": "BSD-Clause-3",
    "summary": "open source Python modules for the IBM Environmental Intelligence Geospatial APIs platform",
    "version": "3.1.7",
    "project_urls": {
        "Documentation": "https://ibm.github.io/ibmpairs/",
        "Homepage": "https://ibm.github.io/ibmpairs/",
        "Source": "https://github.com/ibm/ibmpairs",
        "Tracker": "https://github.com/ibm/ibmpairs/issues"
    },
    "split_keywords": [
        "ibm",
        "environmental",
        "intelligence",
        "geospatial",
        "apis",
        "geospatial",
        "analytics",
        "pairs",
        "gis",
        "biggeodata"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "72b206fddcc5953b774020f41f3bf91a922df2f02d0328ca000bcff7b831840f",
                "md5": "4d069b6ce9c994e1e3c67367c61cdd91",
                "sha256": "5ac65f9d1de24adc1fd95b94582df6634940317b299a6cae0c2c8eaa97e60d7a"
            },
            "downloads": -1,
            "filename": "ibmpairs-3.1.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4d069b6ce9c994e1e3c67367c61cdd91",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 192091,
            "upload_time": "2025-01-27T13:33:45",
            "upload_time_iso_8601": "2025-01-27T13:33:45.866647Z",
            "url": "https://files.pythonhosted.org/packages/72/b2/06fddcc5953b774020f41f3bf91a922df2f02d0328ca000bcff7b831840f/ibmpairs-3.1.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "05b698deb535c59e9c812321800a9a7b721a04dc1ea9bd37f39d06e86b9f4d8a",
                "md5": "0d7b56ab0f9890c3460dd69943d51b6c",
                "sha256": "83b6e53e1c8035eaf31d8cab1dcb61703eda9a625f9667c2fbc34caf7a00c626"
            },
            "downloads": -1,
            "filename": "ibmpairs-3.1.7.tar.gz",
            "has_sig": false,
            "md5_digest": "0d7b56ab0f9890c3460dd69943d51b6c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 188531,
            "upload_time": "2025-01-27T13:33:47",
            "upload_time_iso_8601": "2025-01-27T13:33:47.401687Z",
            "url": "https://files.pythonhosted.org/packages/05/b6/98deb535c59e9c812321800a9a7b721a04dc1ea9bd37f39d06e86b9f4d8a/ibmpairs-3.1.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-27 13:33:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ibm",
    "github_project": "ibmpairs",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "aiohttp",
            "specs": [
                [
                    ">=",
                    "3.0.0"
                ]
            ]
        },
        {
            "name": "fs",
            "specs": []
        },
        {
            "name": "future",
            "specs": []
        },
        {
            "name": "geojson",
            "specs": []
        },
        {
            "name": "ibm_cos_sdk",
            "specs": []
        },
        {
            "name": "jsonschema",
            "specs": []
        },
        {
            "name": "numpy",
            "specs": [
                [
                    ">=",
                    "1.18.1"
                ]
            ]
        },
        {
            "name": "pandas",
            "specs": [
                [
                    ">=",
                    "1.0.1"
                ]
            ]
        },
        {
            "name": "Pillow",
            "specs": [
                [
                    ">=",
                    "10.2.0"
                ]
            ]
        },
        {
            "name": "polling",
            "specs": []
        },
        {
            "name": "pytz",
            "specs": []
        },
        {
            "name": "rasterio",
            "specs": []
        },
        {
            "name": "Requests",
            "specs": [
                [
                    ">=",
                    "2.4"
                ]
            ]
        },
        {
            "name": "Shapely",
            "specs": []
        },
        {
            "name": "tableschema",
            "specs": []
        }
    ],
    "lcname": "ibmpairs"
}
        
Elapsed time: 1.10931s