Contents

Overview

docs Documentation Status
tests
Github Actions Build Status Dependabot dependency management
Coverage Status

Validate ERDDAP XML files and snippets to make sure they conform to best practices.

  • Free software: MIT license

Installation

pip install erddap-xml

You can also install the in-development version with:

pip install https://github.com/gulfofmaine/python-erddap-xml-validator/archive/master.zip

Documentation

Read the docs

erddap_xml can be imported into a larger project, and can be used from the command line.

erddap_xml_validate path/to/dataset.xml will check if an XML chunk for a single dataset is correctly formatted. It will print Valid Dataset if it’s correctly formatted, or raise an exception pointing to the specific check that the dataset failed.

Development

To run the all tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows 
set PYTEST_ADDOPTS=--cov-append
tox
Other 
PYTEST_ADDOPTS=--cov-append tox

Installation

At the command line:

pip install erddap-xml

Usage

To use ERDDAP XML validator in a project:

import erddap_xml

Reference

erddap_xml

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Documentation improvements

ERDDAP XML validator could always use more documentation, whether as part of the official ERDDAP XML validator docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/gulfofmaine/python-erddap-xml-validator/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

To set up python-erddap-xml-validator for local development:

  1. Fork python-erddap-xml-validator (look for the “Fork” button).

  2. Clone your fork locally:

    git clone git@github.com:gulfofmaine/python-erddap-xml-validator.git

  3. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  4. Install development version to tinker:

    python setup.py develop

  5. When you’re done making changes run all the checks and docs builder with tox one command:

    tox

  6. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (run tox) [1].
  2. Update documentation when there’s new API, functionality etc.
  3. Add a note to CHANGELOG.rst about the changes.
  4. Add yourself to AUTHORS.rst.
[1]

If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request.

It will be slower though …

Tips

To run a subset of tests:

tox -e envname -- pytest -k test_myfeature

To run all the test environments in parallel (you need to pip install detox):

detox

Authors

Changelog

0.0.0 (2020-01-17)

  • First release on PyPI.

Indices and tables