Skip to content

Latest commit

 

History

History
104 lines (70 loc) · 2.51 KB

README.md

File metadata and controls

104 lines (70 loc) · 2.51 KB
Raw

wis2box-csv-observations

Overview

wis2box CSV observations data ingest plugin

Installation

The easiest way to install wis2box-csv-observations is via the Python pip utility:

# via PyPI
pip install wis2box-csv-observations

# directly from GitHub
pip install https://github.com/wmo-cop/wis2box-csv-observations/archive/main.zip

Requirements

Dependencies

Dependencies are listed in requirements.txt. Dependencies are automatically installed during wis2box-csv-observations installation.

Installing wis2box-csv-observations

# setup virtualenv
python3 -m venv --system-site-packages wis2box-csv-observations
cd wis2box-csv-observations
source bin/activate

# clone codebase and install
git clone https://github.com/wmo-cop/wis2box-csv-observations.git
cd wis2box-csv-observations
python setup.py build
python setup.py install

Running

  • install into wis2box container/environment
  • update WIS2BOX_DATADIR_DATA_MAPPINGS (see sample data-mappings.yml)
# create dataset topic hierarchy directories
wis2box data setup --topic-hierarchy observations-surface-land.mw.FWCL.landFixed

# display dataset topic hierarchy and directories
wis2box data info --topic-hierarchy observations-surface-land.mw.FWCL.landFixed

# process incoming data file (manually/no PubSub)
wis2box data process /path/to/file.csv

# process incoming data directory (manually/no PubSub)
wis2box data process /path/to/dir

# copy discovery-metadata.yml into $WIS2BOX_DATADIR/metadata/discovery
cp discovery-metadata.yml $WIS2BOX_DATADIR/metadata/discovery

# publish dataset discovery metadata to local catalogue
wis2box metadata discovery publish observations-surface-land.mw.FWCL.landFixed

# unpublish discovery metadata to local catalogue
wis2box metadata discovery unpublish observations-surface-land.mw.FWCL.landFixed

Development

Running Tests

# install dev requirements
pip install -r requirements-dev.txt

# run tests like this:
python tests/run_tests.py

# or this:
python setup.py test

Releasing

python setup.py sdist bdist_wheel --universal
twine upload dist/*

Code Conventions

Bugs and Issues

All bugs, enhancements and issues are managed on GitHub.

Contact