pyheimdall-rst 0.5.0

reStructuredText connector for pyHeimdall

What is this?

pyHeimdall is a tool for converting more easily one or more databases from one format to another. It leverages modules called “connectors”, responsible for conversion of data between specific databases schemas and the HERA format.

This repository implements a connector to import any database composed of reStructuredText (RST) files. The implementation doesn’t need any intervention on pyHeimdall proper.

How can I use it?

Setup

This RST pyHeimdall connector is available as a PyPI package named pyheimdall-rst. You can install it using the pip package manager:

You can install this connector using the pip package manager:

pip install pyheimdall-rst

You can use pip to either upgrade or uninstall this connector, too:

pip install --upgrade pyheimdall-rst
pip uninstall pyheimdall-rst

Usage

import heimdall

tree = heimdall.getDatabase(format='rst', url=...)
heimdall.createDatabase(tree, format=..., url=...)

Please note that you don’t need to use pyheimdall-rst functions directly. As long as the package is installed on your system, pyHeimdall will automatically discover its features and allow you to use them as long as any other default or external connector.

Is it documented?

Sure! Here’s the link.

Is it tested?

Of course! Here’s the coverage report.

How can I contribute?

PyHeimdall welcomes any feedback or proposal. Details can be accessed here

License

GNU Affero General Public License version 3.0 or later