> #### DISCLAIMER - BETA PHASE > This XBRL to RDF parser is currently in a beta phase. >
Python package to convert XBRL instance and taxonomy files to RDF
- Free software: GNU GENERAL PUBLIC LICENSE, v2
- Documentation: https://xbrl2rdf.readthedocs.io.
Here is what the package does: - convert XBRL instance file and related taxonomy files (schemas and linkbases) to RDF and RDF-star
To install the package
pip install xbrl2rdf
To install the package from Github
pip install -e git+https://github.com/wjwillemse/xbrl2rdf.git#egg=xbrl2rdf
To parse an XBRL-instance file run in the root of the project
python -m xbrl2rdf.xbrl2rdf
You can contribute in many ways:
Report bugs at https://github.com/wjwillemse/xbrl2rdf/issues.
If you are 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.
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
The best way to send feedback is to file an issue at https://github.com/wjwillemse/xbrl2rdf/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.
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.