Metadata-Version: 2.1
Name: cim-loader
Version: 0.1.3a0
Summary: CIM Database Uploader & Downloader
Author: A. Anderson
Author-email: 19935503+AAndersn@users.noreply.github.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: gridappsd
Requires-Dist: SPARQLWrapper (>=2.0.0,<3.0.0)
Requires-Dist: cim-graph (>=0.1.6a0,<0.2.0)
Requires-Dist: gridappsd-python (>=2024.6.0,<2025.0.0) ; extra == "gridappsd"
Requires-Dist: mysql-connector-python (>=8.0.0,<9.0.0)
Requires-Dist: neo4j (>=5.10.0,<6.0.0)
Requires-Dist: rdflib (>=7.0.0,<8.0.0)
Requires-Dist: rdflib-neo4j (>=0.0.1b6,<0.0.2)
Requires-Dist: requests (>=2.28.0,<3.0.0)
Description-Content-Type: text/markdown

# CIM-Loader
Automated scripts for 
* uploading and downloading CIM files from various databases
* converting CIM files between common formats (XML, TTL, etc.)

## Installation
The library can be pip installed from PyPi using
`pip install cim-loader`

To install a specific branch, clone the repo and install it using
```bash
git clone https://github.com/PNNL-CIM-Tools/CIM-Loader.git -b develop
pip install -e CIM-Loader
```

## Usage

To use CIM-Loader for bulk upload and download, set the connection parameters with the correct url / host / port / username / password and then invoke the associated upload / download method

```python
from cimloader.databases import ConnectionParameters
from cimloader.uploaders import BlazegraphUploader
params = ConnectionParameters(url = "http://localhost:8889/bigdata/namespace/kb/sparql")
loader = BlazegraphUploader(params)

loader.upload_from_file(filepath='./test_models', filename='ieee13_seto.xml')
```


## Databases Supported
Databases to be supported in first full release:
* Blazegraph
* Neo4J
* GraphDB
* MySQL

Support may be added in the future for:
* Apache Tinkerpop
* SQlite
* AVEVA PI Historian
* Others as requested


## Attribution and Disclaimer

This software was created under a project sponsored by the U.S. Department of Energy’s Office of Electricity, an agency of the United States Government.  Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.

Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.

PACIFIC NORTHWEST NATIONAL LABORATORY
operated by
BATTELLE
for the
UNITED STATES DEPARTMENT OF ENERGY
under Contract DE-AC05-76RL01830



