deploy: 40c3c45

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 668f1bb47842b61b7099c8ea860e7af4
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/ead_inspector_guide.rst.txt

@@ -0,0 +1,33 @@
+EADInspector Guide
+===================
+
+Quick Start
+-----------
+
+Import EADInspector::
+
+    from nfdinspector.ead_inspector import EADInspector
+
+Initialize an EADInspector. You can specify a language (currently available: "en" or "de") for the error messages::
+
+    ead_inspector = EADInspector(error_lang="en")
+
+Read EAD file you want to inspect::
+
+    ead_inspector.read_ead_file("file_path")
+
+Refer to a configuration file (optional). Without this step the inspections are executed with a default configuration. It is highly recommended to use different configuration files for archive tectonics and finding aids::
+
+    ead_inspector.config_file("file_path")
+
+Execute the inspections::
+
+    ead_inspector.inspect()
+
+Save the inspections as a JSON file. You can specify the indention (default: None)::
+    
+    ead_inspector.to_json("file_path", indent=4)
+
+Save the inspections as a CSV file. You can specify a field separator/delimiter (default: ",")::
+
+    ead_inspector.to_csv("file_path", delimiter=";")

_sources/index.rst.txt

@@ -0,0 +1,24 @@
+.. NFDInspector documentation master file, created by
+   sphinx-quickstart on Mon Nov 12 14:17:27 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to NFDInspector's documentation!
+========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   intro
+   ead_inspector_guide
+   lido_inspector_guide
+   nfdinspector
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

_sources/intro.rst.txt

@@ -0,0 +1,43 @@
+Introduction
+============
+
+NFDInspector is designed to facilitate the inspection of formal quality issues pertaining to research data. 
+It is currently compatible with the LIDO and EAD metadata standards. 
+The project has been funded by the "4Memory Incubator Funds" of the NFDI4Memory consortium and is being developed and maintained by the Montanhistorisches Dokumentationszentrum (montan.dok) of the Deutsches Bergbau-Museum Bochum.
+
+* `Documentation <https://montan-code.github.io/nfdinspector/>`_
+* `GitHub <https://github.com/montan-code/nfdinspector>`_
+* `PyPI <https://pypi.org/project/NFDInspector/>`_
+* `License <https://pypi.org/project/NFDInspector/>`_
+
+Installation
+------------
+
+To install with pip on macOS or Linux, run::
+
+    python3 -m pip install nfdinspector
+
+To install with pip on Windows, run::
+
+    py -m pip install nfdinspector
+
+Background
+----------
+
+The identification of errors and the measurement of quality in the rapidly growing data collections of memory and research institutions is becoming an increasingly quantitative challenge. 
+In order to meet this challenge, the `Deutsches Bergbau-Museum Bochum <https://www.bergbaumuseum.de/>`_ and `montan.dok <https://www.bergbaumuseum.de/montandok>`_ are developing practical, freely reusable tools for the systematic assurance of data quality in structured research data from museums and archives, funded by the `NFDI4Memory Incubator Funds <https://4memory.de/4memory-incubator-funds/>`_.
+
+To this end, the DBM and montan.dok are developing a series of software applications written in the Python programming language. 
+These tools are designed to facilitate the identification of formal quality deficiencies in standardized data collections, enabling the generation of comprehensive error reports. 
+The initial focus is on `LIDO <https://lido-schema.org/>`_ and `EAD(DDB) <https://wiki.deutsche-digitale-bibliothek.de/pages/viewpage.action?pageId=19010180>`_, which serve as the common exchange formats for cataloguing data from archives and museums. 
+The tools are published as open source and under a free licence as a package in the 'Python Package Index' (PyPI) so that they can be easily reused and form the basis for further applications. 
+This should enable the quality criteria to be further developed in NFDI4Memory and other NFDI consortia to be directly translated into practicable applications and measures to improve data quality to be taken in memory and research institutions.
+
+Community
+---------
+
+Should you wish to become part of the community, to contribute to its activities, or to request assistance, you are invited to do so.
+
+* `Contribution Guide <https://github.com/montan-code/nfdinspector/blob/main/CONTRIBUTING.md>`_
+* `Code of Conduct <https://github.com/montan-code/nfdinspector/blob/main/code_of_conduct.md>`_
+* `File an Issue <https://github.com/montan-code/nfdinspector/issues>`_

_sources/lido_inspector_guide.rst.txt

@@ -0,0 +1,33 @@
+LIDOInspector Guide
+===================
+
+Quick Start
+-----------
+
+Import LIDOInspector::
+
+    from nfdinspector.lido_inspector import LIDOInspector
+
+Initialize a LIDOInspector. You can specify a language (currently available: "en" or "de") for the error messages::
+
+    lido_inspector = LIDOInspector(error_lang="de")
+
+Read LIDO files you want to inspect::
+
+    lido_inspector.read_lido_files("files_path")
+
+Refer to a configuration file (optional). Without this step the inspections are executed with a default configuration::
+
+    lido_inspector.config_file("file_path")
+
+Execute the inspections::
+
+    lido_inspector.inspect()
+
+Save the inspections as a JSON file. You can specify the indention (default: None)::
+
+    lido_inspector.to_json("file_path", indent=4)
+
+Save the inspections as a CSV file. You can specify a field separator/delimiter (default: ",")::
+
+    lido_inspector.to_csv("file_path", delimiter=";")

_sources/modules.rst.txt

@@ -0,0 +1,7 @@
+nfdinspector
+============
+
+.. toctree::
+   :maxdepth: 4
+
+   nfdinspector

_sources/nfdinspector.rst.txt

@@ -0,0 +1,42 @@
+Reference
+====================
+
+nfdinspector.ead\_inspector module
+----------------------------------
+
+.. automodule:: nfdinspector.ead_inspector
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+nfdinspector.error module
+-------------------------
+
+.. automodule:: nfdinspector.error
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+nfdinspector.lido\_inspector module
+-----------------------------------
+
+.. automodule:: nfdinspector.lido_inspector
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+nfdinspector.metadata\_inspector module
+---------------------------------------
+
+.. automodule:: nfdinspector.metadata_inspector
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: nfdinspector
+   :members:
+   :undoc-members:
+   :show-inheritance: