Metadata-Version: 2.1
Name: csv2bufr
Version: 0.8.2
Summary: Configurable module to convert data from CSV to WMO BUFR format
Home-page: https://github.com/wmo-im/csv2bufr
Author: David I. Berry
Author-email: DBerry@wmo.int
Maintainer: David I. Berry
Maintainer-email: DBerry@wmo.int
License: Apache Software License
Description: # csv2bufr
        
        The csv2bufr Python module contains both a command line interface and an API to convert data stored in a CSV file to the WMO BUFR data format.
        More information on the BUFR format can be found in the [WMO Manual on Codes, Volume I.2](https://library.wmo.int/doc_num.php?explnum_id=10722).
        
        ## Installation
        
        ### Requirements
        - Python 3 and above
        - [ecCodes](https://confluence.ecmwf.int/display/ECC)
        
        ### Dependencies
        
        Dependencies are listed in [requirements.txt](https://github.com/wmo-im/csv2bufr/blob/main/requirements.txt). Dependencies are automatically installed during csv2bufr installation.
        
        ```bash
        docker pull wmoim/csv2bufr
        ```
        
        ## Running
        
        Transform data from file ``<my-csv-file.csv>``  for station ``<wigos_station_identifier>`` to BUFR using template 
        specified in file ``<csv-to-bufr-mapping.json>`` and with station metadata file the file ``<metadata-file.csv>``. 
        Write output to ``<output-directory-path>``.
        
        ```bash
        csv2bufr data transform <my-csv-file.csv> \
            <wigos_station_identifier> \
            --station-metadata <metadata-file.csv> \
            --bufr-template <csv-to-bufr-mapping.json> \
            --output <output-directory-path>
        ```
        
        ## Releasing
        
        ```bash
        # create release (x.y.z is the release version)
        vi csv2bufr/__init__.py  # update __version__
        git commit -am 'update release version vx.y.z'
        git push origin main
        git tag -a vx.y.z -m 'tagging release version vx.y.z'
        git push --tags
        
        # upload to PyPI
        rm -fr build dist *.egg-info
        python setup.py sdist bdist_wheel --universal
        twine upload dist/*
        
        # publish release on GitHub (https://github.com/wmo-im/csv2bufr/releases/new)
        
        # bump version back to dev
        vi csv2bufr/__init__.py  # update __version__
        git commit -am 'back to dev'
        git push origin main
        ```
        ## Documentation
        
        The full documentation for csv2bufr can be found at [https://csv2bufr.readthedocs.io](https://csv2bufr.readthedocs.io), including sample files.
        
        ### Code Conventions
        
        * [PEP8](https://www.python.org/dev/peps/pep-0008)
        
        ### Bugs and Issues
        
        All bugs, enhancements and issues are managed on [GitHub](https://github.com/wmo-im/csv2bufr/issues).
        
        ## Contact
        
        * [David Berry](https://github.com/david-i-berry)
Keywords: WMO BUFR csv encoding weather observations
Platform: all
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
