Metadata-Version: 2.1
Name: cimpyorm
Version: 0.9.1
Summary: A database-backed ORM for CIM datasets.
Home-page: http://www.iaew.rwth-aachen.de
Author: Thomas Offergeld
Author-email: t.offergeld@iaew.rwth-aachen.de
License: UNKNOWN
Project-URL: homepage, http://www.iaew.rwth-aachen.de
Description: ## Installation
        
        ###### PyPI:
        
        ```pip install cimpyorm```
        
        ---
        ##### Documentation
        
        Some documentation can be found at [readthedocs](https://cimpyorm.readthedocs.io/en/latest/).
        
        ---
        ## Usage
        ```python
        import cimpyorm
        ```
        
        ---
        ##### Loading datasets from cimpyorm-.db file
        ```python
        session, m = cimpyorm.load(r"Path/To/DatabaseFile") # Load an existing .db file
        ```
        
        ---
        ##### Parsing datasets
        ```python
        session, m = cimpyorm.parse(r"Path/To/Folder/Containing/Export") # Parse a .xml export (also creates a cimpyorm-.db file of the export)
        ```
        To configure additional schemata (currently only the schema for the CGMES profiles are distributed
        with the application), create additional subfolders in the ```/res/schemata/``` directory 
        containg the schema RDFS.
        
        ---
        ##### Running the tests
        You can run the included test-suite by running ```cimpyorm.test_all()```.
        
        ---
        ##### Querying datasets
        ```python
        all_terminals = session.query(m.Terminal).all()
        names_of_ConductingEquipment = [t.ConductingEquipment.name for t in all_terminals]
        ```
        
        ---
        ## Bug reports/feature requests
        Please use the Issue Tracker.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
