PySimultan 0.5.5__tar.gz → 0.5.6__tar.gz

pysimultan-0.5.6/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.3
+Name: PySimultan
+Version: 0.5.6
+Project-URL: Documentation, https://github.com/Bühler Maximilian/PySimultan2#readme
+Project-URL: Issues, https://github.com/Bühler Maximilian/PySimultan2/issues
+Project-URL: Source, https://github.com/Bühler Maximilian/PySimultan2
+Author-email: Bühler Maximilian <maximilian.buehler@tuwien.ac.at>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Requires-Dist: colorlog
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pyarrow
+Requires-Dist: pythonnet
+Requires-Dist: ruamel-yaml
+Requires-Dist: six
+Requires-Dist: tqdm
+Description-Content-Type: text/markdown
+
+# pysimultan
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pysimultan.svg)](https://pypi.org/project/pysimultan)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pysimultan.svg)](https://pypi.org/project/pysimultan)
+
+PySimultan is a Python library designed to facilitate the creation, manipulation, and management of SIMULTAN data models, taxonomies, and templates. It provides a structured way to define and interact with complex data structures, making it particularly useful for applications that require detailed data organization and templating.  
+Key Features:
+- Data Models: Create and manage data SIMULTAN models with ease.
+- Taxonomies: Define and use taxonomies to categorize and structure data.
+- File and Directory Management: Handle files and directories within the data models.
+- Mapping of Python objects to SIMULTAN data models: Map Python objects to SIMULTAN data models for easy data creation and manipulation.
+- Simple integration in existing Python projects: Easily integrate PySimultan into existing Python projects to enhance data management capabilities.
+
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+- [Usage](#usage)
+- [Change Log](#change-log)
+
+## Installation
+
+```console
+pip install PySimultan
+```
+
+## License
+
+`PySimultan` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+
+
+# Usage
+
+### Data Models
+
+Create a new data model:
+```python
+from PySimultan2 import DataModel
+
+# Create a new data model
+data_model = DataModel.create_new_project(project_path='my_project.simultan',
+                                          user_name='admin',
+                                          password='admin')
+```
+
+Load an existing data model:
+```python
+from PySimultan2 import DataModel
+
+# Load an existing data model
+data_model = DataModel(project_path='my_project.simultan',
+                       user_name='admin',
+                       password='admin')
+```
+
+save the data model:
+```python
+data_model.save()
+```
+
+close and cleanup the data model:
+```python
+data_model.cleanup()
+```
+
+
+### Mapping python to SIMULTAN
+
+#### Create a mapped class:
+```python
+from PySimultan2 import DataModel, TaxonomyMap, Content, PythonMapper
+
+mapper = PythonMapper()
+
+class TestComponent(object):
+    def __init__(self, *args, **kwargs):
+        self.param_1 = kwargs.get('param_1')
+        self.param_2 = kwargs.get('param_2')
+
+content0 = Content(text_or_key='param_1',  # text or key of the content/parameter/property
+                   property_name='param_1',  # name of the generated property
+                   type=None,  # type of the content/parameter/property
+                   unit=None,  # unit of the content/parameter/property
+                   documentation='param_1 to test')
+
+content1 = Content(text_or_key='param_2',  # text or key of the content/parameter/property
+                   property_name='param_2',  # name of the generated property
+                   type=None,  # type of the content/parameter/property
+                   unit=None,  # unit of the content/parameter/property
+                   documentation='param_2 to test')
+
+test_component_map = TaxonomyMap(taxonomy_name='PySimultan',
+                                 taxonomy_key='Test',
+                                 taxonomy_entry_name='test_component',
+                                 taxonomy_entry_key='test_component',
+                                 content=[content0, content1],
+                                 )
+
+mapper.register(test_component_map.taxonomy_entry_key, TestComponent, taxonomy_map=test_component_map)
+```
+
+#### Create an instance of the mapped class:
+```python
+# get the mapped class
+mapped_test_component_cls = mapper.get_mapped_class('test_component')
+
+# create an instance of the mapped class
+mapped_test_component = mapped_test_component_cls(param_1='value1', 
+                                                  param_2='value2',
+                                                  data_model=data_model)
+
+# save the data_model
+data_model.save()
+
+# cleanup the data_model
+data_model.cleanup()
+```
+
+#### Load an instance of the mapped class:
+```python
+# load the data_model
+data_model = DataModel(project_path='my_project.simultan',
+                       user_name='admin',
+                       password='admin')
+                       
+# get the mapped class
+mapped_test_component_cls = mapper.get_mapped_class('test_component')
+
+# get the instances of the mapped class
+instances = mapped_test_component_cls.cls_instaces
+
+print(instances[0].param_1)
+```
+
+
+# Change Log
+
+## [0.4.20] - 2024-07-01
+- Fixed Bug in nested dictionary creation
+
+## [0.4.19] - 2024-07-01
+- Refactored dictionaries 

pysimultan-0.5.6/README.md

@@ -0,0 +1,145 @@
+# pysimultan
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pysimultan.svg)](https://pypi.org/project/pysimultan)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pysimultan.svg)](https://pypi.org/project/pysimultan)
+
+PySimultan is a Python library designed to facilitate the creation, manipulation, and management of SIMULTAN data models, taxonomies, and templates. It provides a structured way to define and interact with complex data structures, making it particularly useful for applications that require detailed data organization and templating.  
+Key Features:
+- Data Models: Create and manage data SIMULTAN models with ease.
+- Taxonomies: Define and use taxonomies to categorize and structure data.
+- File and Directory Management: Handle files and directories within the data models.
+- Mapping of Python objects to SIMULTAN data models: Map Python objects to SIMULTAN data models for easy data creation and manipulation.
+- Simple integration in existing Python projects: Easily integrate PySimultan into existing Python projects to enhance data management capabilities.
+
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+- [Usage](#usage)
+- [Change Log](#change-log)
+
+## Installation
+
+```console
+pip install PySimultan
+```
+
+## License
+
+`PySimultan` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+
+
+# Usage
+
+### Data Models
+
+Create a new data model:
+```python
+from PySimultan2 import DataModel
+
+# Create a new data model
+data_model = DataModel.create_new_project(project_path='my_project.simultan',
+                                          user_name='admin',
+                                          password='admin')
+```
+
+Load an existing data model:
+```python
+from PySimultan2 import DataModel
+
+# Load an existing data model
+data_model = DataModel(project_path='my_project.simultan',
+                       user_name='admin',
+                       password='admin')
+```
+
+save the data model:
+```python
+data_model.save()
+```
+
+close and cleanup the data model:
+```python
+data_model.cleanup()
+```
+
+
+### Mapping python to SIMULTAN
+
+#### Create a mapped class:
+```python
+from PySimultan2 import DataModel, TaxonomyMap, Content, PythonMapper
+
+mapper = PythonMapper()
+
+class TestComponent(object):
+    def __init__(self, *args, **kwargs):
+        self.param_1 = kwargs.get('param_1')
+        self.param_2 = kwargs.get('param_2')
+
+content0 = Content(text_or_key='param_1',  # text or key of the content/parameter/property
+                   property_name='param_1',  # name of the generated property
+                   type=None,  # type of the content/parameter/property
+                   unit=None,  # unit of the content/parameter/property
+                   documentation='param_1 to test')
+
+content1 = Content(text_or_key='param_2',  # text or key of the content/parameter/property
+                   property_name='param_2',  # name of the generated property
+                   type=None,  # type of the content/parameter/property
+                   unit=None,  # unit of the content/parameter/property
+                   documentation='param_2 to test')
+
+test_component_map = TaxonomyMap(taxonomy_name='PySimultan',
+                                 taxonomy_key='Test',
+                                 taxonomy_entry_name='test_component',
+                                 taxonomy_entry_key='test_component',
+                                 content=[content0, content1],
+                                 )
+
+mapper.register(test_component_map.taxonomy_entry_key, TestComponent, taxonomy_map=test_component_map)
+```
+
+#### Create an instance of the mapped class:
+```python
+# get the mapped class
+mapped_test_component_cls = mapper.get_mapped_class('test_component')
+
+# create an instance of the mapped class
+mapped_test_component = mapped_test_component_cls(param_1='value1', 
+                                                  param_2='value2',
+                                                  data_model=data_model)
+
+# save the data_model
+data_model.save()
+
+# cleanup the data_model
+data_model.cleanup()
+```
+
+#### Load an instance of the mapped class:
+```python
+# load the data_model
+data_model = DataModel(project_path='my_project.simultan',
+                       user_name='admin',
+                       password='admin')
+                       
+# get the mapped class
+mapped_test_component_cls = mapper.get_mapped_class('test_component')
+
+# get the instances of the mapped class
+instances = mapped_test_component_cls.cls_instaces
+
+print(instances[0].param_1)
+```
+
+
+# Change Log
+
+## [0.4.20] - 2024-07-01
+- Fixed Bug in nested dictionary creation
+
+## [0.4.19] - 2024-07-01
+- Refactored dictionaries 

pysimultan-0.5.6/src/PySimultan2/__about__.py

@@ -0,0 +1 @@
+version = '0.5.6'

pysimultan-0.5.5/PKG-INFO

@@ -1,91 +0,0 @@
-Metadata-Version: 2.3
-Name: PySimultan
-Version: 0.5.5
-Project-URL: Documentation, https://github.com/Bühler Maximilian/PySimultan2#readme
-Project-URL: Issues, https://github.com/Bühler Maximilian/PySimultan2/issues
-Project-URL: Source, https://github.com/Bühler Maximilian/PySimultan2
-Author-email: Bühler Maximilian <maximilian.buehler@tuwien.ac.at>
-License: MIT
-Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.8
-Requires-Dist: colorlog
-Requires-Dist: numpy
-Requires-Dist: pandas
-Requires-Dist: pyarrow
-Requires-Dist: pythonnet
-Requires-Dist: ruamel-yaml
-Requires-Dist: six
-Requires-Dist: tqdm
-Description-Content-Type: text/markdown
-
-# pysimultan_api
-
-[![PyPI - Version](https://img.shields.io/pypi/v/pysimultan-api.svg)](https://pypi.org/project/pysimultan-api)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pysimultan-api.svg)](https://pypi.org/project/pysimultan-api)
-
------
-
-## Table of Contents
-
-- [Installation](#installation)
-- [License](#license)
-- [Usage](#usage)
-- [FreeCAD support](#freecad-support)
-- [Change Log](#change-log)
-
-## Installation
-
-```console
-pip install PySimultan
-```
-
-## License
-
-`pysimultan-api` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
-
-
-### Usage
-
-```python
-from PySimultan2 import DataModel, Content, TaxonomyMap, PythonMapper
-```
-
-
-## FreeCAD support
-
-PySimultanUI looks for a FreeCAD version in C:\Program Files\FreeCAD. If you don't have FreeCAD installed, you can 
-download it from the FreeCAD website or use the FreeCAD version provided in the FreeCAD-Bundle repository.
-Go to https://github.com/FreeCAD/FreeCAD-Bundle/releases/tag/weekly-builds and download the latest version 
-of FreeCAD for your OS. The version must be compiled with the same python version you are using (e.g. py311). 
-
-Extract the zip file to C:\Program Files\FreeCAD
-
-The directory structure should look like this:
-
-```
-C:\Program Files\FreeCAD
-│   ...
-│   FreeCAD_weekly-builds-37730-conda-Windows-x86_64-py311
-│       │   bin
-│       │   lib
-│       │   ...
-│
-
-```
-
-
-# Change Log
-
-## [0.4.20] - 2024-07-01
-- Fixed Bug in nested dictionary creation
-
-## [0.4.19] - 2024-07-01
-- Refactored dictionaries 

pysimultan-0.5.5/README.md

@@ -1,63 +0,0 @@
-# pysimultan_api
-
-[![PyPI - Version](https://img.shields.io/pypi/v/pysimultan-api.svg)](https://pypi.org/project/pysimultan-api)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pysimultan-api.svg)](https://pypi.org/project/pysimultan-api)
-
------
-
-## Table of Contents
-
-- [Installation](#installation)
-- [License](#license)
-- [Usage](#usage)
-- [FreeCAD support](#freecad-support)
-- [Change Log](#change-log)
-
-## Installation
-
-```console
-pip install PySimultan
-```
-
-## License
-
-`pysimultan-api` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
-
-
-### Usage
-
-```python
-from PySimultan2 import DataModel, Content, TaxonomyMap, PythonMapper
-```
-
-
-## FreeCAD support
-
-PySimultanUI looks for a FreeCAD version in C:\Program Files\FreeCAD. If you don't have FreeCAD installed, you can 
-download it from the FreeCAD website or use the FreeCAD version provided in the FreeCAD-Bundle repository.
-Go to https://github.com/FreeCAD/FreeCAD-Bundle/releases/tag/weekly-builds and download the latest version 
-of FreeCAD for your OS. The version must be compiled with the same python version you are using (e.g. py311). 
-
-Extract the zip file to C:\Program Files\FreeCAD
-
-The directory structure should look like this:
-
-```
-C:\Program Files\FreeCAD
-│   ...
-│   FreeCAD_weekly-builds-37730-conda-Windows-x86_64-py311
-│       │   bin
-│       │   lib
-│       │   ...
-│
-
-```
-
-
-# Change Log
-
-## [0.4.20] - 2024-07-01
-- Fixed Bug in nested dictionary creation
-
-## [0.4.19] - 2024-07-01
-- Refactored dictionaries 

pysimultan-0.5.5/src/PySimultan2/__about__.py

@@ -1 +0,0 @@
-version = '0.5.5'