simonwiles/xmltotabular

Python library for converting XML to tabular data.

xmltotabular

Python library for converting XML to tabular data.

Current Status

This library is under periodic development. It is useful as it stands (see sul-cidr/patent_data_extractor for the de facto reference implementation), but there is still much to be done before a 1.0 release. Please get in touch if this project could be useful to you, and especially if you'd be interesting in contributing (I would welcome help with documentation and examples for a robust test suite, for example).

Development

With a working version of Python >= 3.6 and Pipenv:

1. Install dependencies.
   (note that a Pipfile.lock is not included in this repository -- this library should work with any dependency versions which satisfy what is listed in the Pipfile and setup.py, and any necessary pinning should be specified in both)

   $ pipenv install --dev

2. Install pre-commit hooks.

   $ pipenv run pre-commit install

Testing

• Linting and formatting.

  $ pipenv run pre-commit run --all-files

• Tests

  $ pipenv run pytest

• Coverage

  To collect coverage execution data, use:

  $ pipenv run coverage run -m pytest

  and to get a report on the data, use:

  $ pipenv run coverage report -m

  or

  $ pipenv run coverage html

  to create an HTML report in htmlcov/.