pywiscat

Name	pywiscat JSON
Version	0.2.0 JSON
	download
home_page	https://github.com/wmo-im/pywiscat
Summary	WMO WIS Catalogue analysis tool
upload_time	2024-04-05 11:39:12
maintainer	Tom Kralidis
docs_url	None
author	Tom Kralidis
requires_python	None
license	MIT
keywords	wmo wis
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # pywiscat

[![Build Status](https://github.com/wmo-im/pywiscat/workflows/build%20%E2%9A%99%EF%B8%8F/badge.svg)](https://github.com/wmo-im/pywiscat/actions)

## Pythonic API to WMO WIS Catalogue

pywiscat provides a Pythonic API atop the WMO WIS2 Catalogue in support
of reporting and analysis of the WIS2 Catalogue and its associated discovery metadata.

## Installation

### pip

Install latest stable version from [PyPI](https://pypi.org/project/pywiscat).

```bash
pip3 install pywiscat
```

### From source

Install latest development version.

```bash
python3 -m venv pywiscat
cd pywiscat
. bin/activate
git clone https://github.com/wmo-im/pywiscat.git
cd pywiscat
pip3 install -r requirements.txt
python3 setup.py build
python3 setup.py install
```

## Running

The canonical URL for the GDC is https://api.weather.gc.ca.

To use a different catalogue, set the `PYWISCAT_GDC_URL` environmnent variable before running pywiscat.

From command line:

```bash
# fetch version
pywiscat --version

## WIS2 workflows

# search the WIS2 Global Discovery Catalogue (GDC)
pywiscat search

# search the WIS2 Global Discovery Catalogue (GDC) with a full text query
pywiscat search --query radar

# search the WIS2 Global Discovery Catalogue (GDC) for only recommended data
pywiscat search --data-policy recommended

# search the WIS2 Global Discovery Catalogue (GDC) with a bounding box query
pywiscat search --bbox -142,42,-52,84

# get more information about a WIS2 GDC record
pywiscat get urn:x-wmo:md:can:eccc-msc:c7c9d726-c48a-49e3-98ab-78a1ab87cda8
```

## Using the API
```python

## WIS2 workflows

from pywiscat.wis2.catalogue import search, get

# search catalogue
results = search(q='radar', bbox=[-142, 42, -52, 84]))

# get a single catalogue record
results = get('urn:x-wmo:md:can:eccc-msc:c7c9d726-c48a-49e3-98ab-78a1ab87cda8')
```


## Development

```bash
python3 -m venv pywiscat
cd pywiscat
source bin/activate
git clone https://github.com/wmo-im/pywiscat.git
pip3 install -r requirements.txt
pip3 install -r requirements-dev.txt
python3 setup.py install
```

### Running tests

```bash
# via setuptools
python3 setup.py test
# manually
python3 tests/run_tests.py
```

## Releasing

```bash
# create release (x.y.z is the release version)
vi pywiscat/__init__.py  # update __version__
git commit -am 'update release version x.y.z'
git push origin master
git tag -a x.y.z -m 'tagging release version x.y.z'
git push --tags

# upload to PyPI
rm -fr build dist *.egg-info
python3 setup.py sdist bdist_wheel --universal
twine upload dist/*

# publish release on GitHub (https://github.com/wmo-im/pywiscat/releases/new)

# bump version back to dev
vi pywiscat/__init__.py  # update __version__
git commit -am 'back to dev'
git push origin master
```

## Code Conventions

[PEP8](https://www.python.org/dev/peps/pep-0008)

## Issues

Issues are managed at https://github.com/wmo-im/pywiscat/issues

## Contact

* [Tom Kralidis](https://github.com/tomkralidis)
* [Ján Osuský](https://github.com/josusky)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/wmo-im/pywiscat",
    "name": "pywiscat",
    "maintainer": "Tom Kralidis",
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "tomkralidis@gmail.com",
    "keywords": "wmo wis",
    "author": "Tom Kralidis",
    "author_email": "tomkralidis@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/bd/26/6c50411d2bab511cce59a2d5ec0e59e7380320bb97ce27bd030298dba5be/pywiscat-0.2.0.tar.gz",
    "platform": "all",
    "description": "# pywiscat\n\n[![Build Status](https://github.com/wmo-im/pywiscat/workflows/build%20%E2%9A%99%EF%B8%8F/badge.svg)](https://github.com/wmo-im/pywiscat/actions)\n\n## Pythonic API to WMO WIS Catalogue\n\npywiscat provides a Pythonic API atop the WMO WIS2 Catalogue in support\nof reporting and analysis of the WIS2 Catalogue and its associated discovery metadata.\n\n## Installation\n\n### pip\n\nInstall latest stable version from [PyPI](https://pypi.org/project/pywiscat).\n\n```bash\npip3 install pywiscat\n```\n\n### From source\n\nInstall latest development version.\n\n```bash\npython3 -m venv pywiscat\ncd pywiscat\n. bin/activate\ngit clone https://github.com/wmo-im/pywiscat.git\ncd pywiscat\npip3 install -r requirements.txt\npython3 setup.py build\npython3 setup.py install\n```\n\n## Running\n\nThe canonical URL for the GDC is https://api.weather.gc.ca.\n\nTo use a different catalogue, set the `PYWISCAT_GDC_URL` environmnent variable before running pywiscat.\n\nFrom command line:\n\n```bash\n# fetch version\npywiscat --version\n\n## WIS2 workflows\n\n# search the WIS2 Global Discovery Catalogue (GDC)\npywiscat search\n\n# search the WIS2 Global Discovery Catalogue (GDC) with a full text query\npywiscat search --query radar\n\n# search the WIS2 Global Discovery Catalogue (GDC) for only recommended data\npywiscat search --data-policy recommended\n\n# search the WIS2 Global Discovery Catalogue (GDC) with a bounding box query\npywiscat search --bbox -142,42,-52,84\n\n# get more information about a WIS2 GDC record\npywiscat get urn:x-wmo:md:can:eccc-msc:c7c9d726-c48a-49e3-98ab-78a1ab87cda8\n```\n\n## Using the API\n```python\n\n## WIS2 workflows\n\nfrom pywiscat.wis2.catalogue import search, get\n\n# search catalogue\nresults = search(q='radar', bbox=[-142, 42, -52, 84]))\n\n# get a single catalogue record\nresults = get('urn:x-wmo:md:can:eccc-msc:c7c9d726-c48a-49e3-98ab-78a1ab87cda8')\n```\n\n\n## Development\n\n```bash\npython3 -m venv pywiscat\ncd pywiscat\nsource bin/activate\ngit clone https://github.com/wmo-im/pywiscat.git\npip3 install -r requirements.txt\npip3 install -r requirements-dev.txt\npython3 setup.py install\n```\n\n### Running tests\n\n```bash\n# via setuptools\npython3 setup.py test\n# manually\npython3 tests/run_tests.py\n```\n\n## Releasing\n\n```bash\n# create release (x.y.z is the release version)\nvi pywiscat/__init__.py  # update __version__\ngit commit -am 'update release version x.y.z'\ngit push origin master\ngit tag -a x.y.z -m 'tagging release version x.y.z'\ngit push --tags\n\n# upload to PyPI\nrm -fr build dist *.egg-info\npython3 setup.py sdist bdist_wheel --universal\ntwine upload dist/*\n\n# publish release on GitHub (https://github.com/wmo-im/pywiscat/releases/new)\n\n# bump version back to dev\nvi pywiscat/__init__.py  # update __version__\ngit commit -am 'back to dev'\ngit push origin master\n```\n\n## Code Conventions\n\n[PEP8](https://www.python.org/dev/peps/pep-0008)\n\n## Issues\n\nIssues are managed at https://github.com/wmo-im/pywiscat/issues\n\n## Contact\n\n* [Tom Kralidis](https://github.com/tomkralidis)\n* [J\u00e1n Osusk\u00fd](https://github.com/josusky)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "WMO WIS Catalogue analysis tool",
    "version": "0.2.0",
    "project_urls": {
        "Homepage": "https://github.com/wmo-im/pywiscat"
    },
    "split_keywords": [
        "wmo",
        "wis"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4be3a14f159f33eaa21fa2df6602b63483cad07a5819e3d7a68ceb3875925661",
                "md5": "8e45918b201a92832c10e923bdbc59ee",
                "sha256": "df2ac03859ce926fc5f0e553a90047fb442ada33bcc9aafd54db168bdc2ef374"
            },
            "downloads": -1,
            "filename": "pywiscat-0.2.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8e45918b201a92832c10e923bdbc59ee",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 10150,
            "upload_time": "2024-04-05T11:39:10",
            "upload_time_iso_8601": "2024-04-05T11:39:10.707831Z",
            "url": "https://files.pythonhosted.org/packages/4b/e3/a14f159f33eaa21fa2df6602b63483cad07a5819e3d7a68ceb3875925661/pywiscat-0.2.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bd266c50411d2bab511cce59a2d5ec0e59e7380320bb97ce27bd030298dba5be",
                "md5": "aab9e19ecdae5c5648905706ab6c2469",
                "sha256": "ca819e90c929ca8a71a9e580e4f8edad81672372f9828491e8a600dd21ac8451"
            },
            "downloads": -1,
            "filename": "pywiscat-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "aab9e19ecdae5c5648905706ab6c2469",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8357,
            "upload_time": "2024-04-05T11:39:12",
            "upload_time_iso_8601": "2024-04-05T11:39:12.301211Z",
            "url": "https://files.pythonhosted.org/packages/bd/26/6c50411d2bab511cce59a2d5ec0e59e7380320bb97ce27bd030298dba5be/pywiscat-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-05 11:39:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "wmo-im",
    "github_project": "pywiscat",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "pywiscat"
}