pandahub 0.3.5__zip → 0.3.6__zip

{pandahub-0.3.5 → pandahub-0.3.6}/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [0.3.6]
+
+    -  IMPROVED consider realm when activating project by name
+    -  IMPROVED housekeeping: clean up project layout, Docker, settings and remove PandaHubClient
+    -  IMPROVED access of correct collection in get_net_ids
+    -  IMPROVED cleaner project version upgrades (early exit, log spam)
+
 ## [0.3.5]
 
     - Fixed version and repaired pyproject.toml

{pandahub-0.3.5 → pandahub-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pandahub
-Version: 0.3.5
+Version: 0.3.6
 Summary: Data hub for pandapower and pandapipes networks based on MongoDB
 Author-email: Jan Ulffers <jan.ulffers@iee.fraunhofer.de>, Leon Thurner <leon.thurner@retoflow.de>, Jannis Kupka <jannis.kupka@retoflow.de>, Mike Vogt <mike.vogt@iee.fraunhofer.de>, Joschka Thurner <joschka.thurner@retoflow.de>, Alexander Scheidler <alexander.scheidler@iee.fraunhofer.de>
 License: Copyright (c) 2022 by University of Kassel, Fraunhofer Institute for Energy Economics
@@ -58,80 +58,20 @@ Provides-Extra: docs
 Provides-Extra: test
 Provides-Extra: all
 License-File: LICENSE
-License-File: AUTHORS
 
 [![pandapower](https://www.pandapower.org/images/pp.svg)](https://www.pandapower.org)         [![pandapipes](https://www.pandapipes.org/images/pp.svg)](https://www.pandapipes.org)
 
 [![pandahub](https://badge.fury.io/py/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/pypi/pyversions/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/e2nIEE/pandahub/blob/master/LICENSE)
 
+pandahub is a data hub for pandapower and pandapipes networks based on MongoDB. It allows you to store pandapower and
+pandapipes networks as well as timeseries in a MongoDB. pandahub allows you to access the database directly through the PandaHub class,
+but also provides a REST-API based on FastAPI. Access through the API is managed with a user management implementation based on FastAPI Users.
 
-pandahub is a data hub for pandapower and pandapipes networks based on MongoDB. It allows you to store pandapower and pandapipes networks as well as timeseries in a MongoDB. pandahub allows you to access the database directly for local development, but also includes a client/server architecture that exposes all relevant methods as an API based on FastAPI. Access through the API is managed with a user management implementation based on FastAPI Users.
+## Development
+`docker compose up -d` runs a mongodb container alongside a pandahub api instance with live reload available
+at http://localhost:8002. To connect to an existing database instead, set `MONGODB_URL` to the connection string through an environment variable / in you `.env` file.
 
-## Setup a local pandahub api
+Swagger UI is available at http://localhost:8002/docs.
 
-Steps to test the client/server structure locally:
-
-1. Start a MongoDB on localhost:27017 (or another custom port)
-
-2. Start the uvicorn server that exposes the API by navigating to "pandahub/api" and running:
-
-   ```
-   # windows
-   set SECRET=secret & python main.py
-
-   # linux
-   SECRET=secret python main.py
-   ```
-
-   or if you don't run mongodb on the default port (27017)
-
-   ```
-   # windows
-   set MONGODB_URL=mongodb://localhost:[mongo-port] & set SECRET=secret & python main.py
-
-   # linux
-   MONGODB_URL=mongodb://localhost:[mongo-port] SECRET=secret python main.py
-   ```
-
-   The API should now run on http://localhost:8002
-
-   >**Note**
-   >A full documentation of all api endpoints can be seen at http://localhost:8002/docs
-
-   >**Note 2**
-   >You can avoid always setting the environment variables for SECRET and MONGODB_URL by creating an `.env` file in `pandahub/api/` with the following content:
-   >```
-   >SECRET=secret
-   >MONGODB_URL=mongodb://localhost:[mongo-port]
-   >```
-
-## Develop with Docker
-
-`docker compose up` starts a mongodb container alongside pandahub with live reload available at http://localhost:8002.
-
-If you want to connect to a running database, set the database url and specify only docker-compose.yml:
-
-    MONGODB_URL=mongodb://localhost:[mongo-port] docker compose -f docker-compose.yml up
-
-
-
-## Use pandahub api with pandahub client
-
-1. Login with the pandahub client
-
-   There are two ways to login with pandahub client
-
-   - If you installed pandahub by pip or with setup.py just run `pandahub-login` in your shell.
-
-   OR
-
-   - Run the following in your python or IPython shell:
-
-   ```
-   from pandahub.client.user_management import login
-   login()
-   ```
-
-   This will guide you through the login process.
-
-2. You only need to login once. After you logged in successfully a configuration file (pandahub.config) containing an authentication token is created in your home directory and will be used every time you use the pandahub client. You only need to login again if you want to use a different instance of the pandahub api.
+If you develop on the library and do not need the fastapi app, `docker compose up db -d` starts only the mongodb
+container.

pandahub-0.3.6/README.md

@@ -0,0 +1,16 @@
+[![pandapower](https://www.pandapower.org/images/pp.svg)](https://www.pandapower.org)         [![pandapipes](https://www.pandapipes.org/images/pp.svg)](https://www.pandapipes.org)
+
+[![pandahub](https://badge.fury.io/py/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/pypi/pyversions/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/e2nIEE/pandahub/blob/master/LICENSE)
+
+pandahub is a data hub for pandapower and pandapipes networks based on MongoDB. It allows you to store pandapower and
+pandapipes networks as well as timeseries in a MongoDB. pandahub allows you to access the database directly through the PandaHub class,
+but also provides a REST-API based on FastAPI. Access through the API is managed with a user management implementation based on FastAPI Users.
+
+## Development
+`docker compose up -d` runs a mongodb container alongside a pandahub api instance with live reload available
+at http://localhost:8002. To connect to an existing database instead, set `MONGODB_URL` to the connection string through an environment variable / in you `.env` file.
+
+Swagger UI is available at http://localhost:8002/docs.
+
+If you develop on the library and do not need the fastapi app, `docker compose up db -d` starts only the mongodb
+container.

{pandahub-0.3.5 → pandahub-0.3.6}/pandahub/__init__.py

@@ -3,4 +3,3 @@ import importlib.metadata
 __version__ = importlib.metadata.version("pandahub")
 
 from pandahub.lib.PandaHub import PandaHub, PandaHubError
-from pandahub.client.PandaHubClient import PandaHubClient

{pandahub-0.3.5 → pandahub-0.3.6}/pandahub/api/internal/db.py

@@ -9,13 +9,12 @@ from fastapi_users_db_beanie.access_token import (
     BeanieBaseAccessToken,
 )
 
-from pandahub.api.internal.settings import REGISTRATION_ADMIN_APPROVAL
-from pandahub.api.internal import settings
+from pandahub.api.internal.settings import REGISTRATION_ADMIN_APPROVAL, MONGODB_URL, MONGODB_USER, MONGODB_PASSWORD
 from pydantic import Field
 
-mongo_client_args = {"host": settings.MONGODB_URL, "uuidRepresentation": "standard", "connect": False}
-if settings.MONGODB_USER:
-    mongo_client_args |= {"username": settings.MONGODB_USER, "password": settings.MONGODB_PASSWORD}
+mongo_client_args = {"host": MONGODB_URL, "uuidRepresentation": "standard", "connect": False}
+if MONGODB_USER:
+    mongo_client_args |= {"username": MONGODB_USER, "password": MONGODB_PASSWORD}
 
 client = motor.motor_asyncio.AsyncIOMotorClient(**mongo_client_args)
 client.get_io_loop = asyncio.get_event_loop

{pandahub-0.3.5 → pandahub-0.3.6}/pandahub/api/internal/settings.py

@@ -1,8 +1,13 @@
 from dotenv import load_dotenv
 import os
 
+def get_os_env(key, default=None):
+    value = os.getenv(key, default)
+    value = default if value == "" else value
+    return value
+
 def settings_bool(var_name, default=None):
-    var = os.getenv(var_name)
+    var = get_os_env(var_name)
     if var is None:
         return default
     if isinstance(var, str) and var.lower() == "true":
@@ -12,7 +17,7 @@ def settings_bool(var_name, default=None):
     return False
 
 def get_secret(key, default=None):
-    secret = os.getenv(key, default)
+    secret = get_os_env(key, default)
     if secret and os.path.isfile(secret):
         with open(secret) as f:
             secret = f.read()
@@ -21,28 +26,28 @@ def get_secret(key, default=None):
 # load variables from .env to environment variables
 load_dotenv()
 
-MONGODB_URL = get_secret("MONGODB_URL") or "mongodb://localhost:27017"
-MONGODB_USER = get_secret("MONGODB_USER") or None
-MONGODB_PASSWORD = get_secret("MONGODB_PASSWORD") or None
+MONGODB_URL = get_secret("MONGODB_URL", "mongodb://localhost:27017")
+MONGODB_USER = get_secret("MONGODB_USER")
+MONGODB_PASSWORD = get_secret("MONGODB_PASSWORD")
 
-MONGODB_GLOBAL_DATABASE_URL = get_secret("MONGODB_GLOBAL_DATABASE_URL") or None
-MONGODB_GLOBAL_DATABASE_USER = get_secret("MONGODB_GLOBAL_DATABASE_USER") or None
-MONGODB_GLOBAL_DATABASE_PASSWORD = get_secret("MONGODB_GLOBAL_DATABASE_PASSWORD") or None
+MONGODB_GLOBAL_DATABASE_URL = get_secret("MONGODB_GLOBAL_DATABASE_URL")
+MONGODB_GLOBAL_DATABASE_USER = get_secret("MONGODB_GLOBAL_DATABASE_USER")
+MONGODB_GLOBAL_DATABASE_PASSWORD = get_secret("MONGODB_GLOBAL_DATABASE_PASSWORD")
 if not MONGODB_GLOBAL_DATABASE_URL:
-    MONGODB_GLOBAL_DATABASE_URL = os.getenv("MONGODB_URL_GLOBAL_DATABASE") or None
+    MONGODB_GLOBAL_DATABASE_URL = get_os_env("MONGODB_URL_GLOBAL_DATABASE")
 
 EMAIL_VERIFICATION_REQUIRED = settings_bool("EMAIL_VERIFICATION_REQUIRED", default=False)
 
-MAIL_USERNAME = os.getenv("MAIL_USERNAME") or "dummy@mail.de"
-MAIL_PASSWORD = os.getenv("MAIL_PASSWORD") or ""
-MAIL_PORT = os.getenv("MAIL_PORT") or 587
-MAIL_SMTP_SERVER = os.getenv("MAIL_SMTP_SERVER") or ""
+MAIL_USERNAME = get_os_env("MAIL_USERNAME", "dummy@mail.de")
+MAIL_PASSWORD = get_os_env("MAIL_PASSWORD", "")
+MAIL_PORT = get_os_env("MAIL_PORT", 587)
+MAIL_SMTP_SERVER = get_os_env("MAIL_SMTP_SERVER", "")
 MAIL_STARTTLS = settings_bool("MAIL_STARTTLS", default=True)
 MAIL_SSL_TLS = settings_bool("MAIL_SSL_TLS", default=False)
 
-PASSWORD_RESET_URL = os.getenv("PASSWORD_RESET_URL") or ""
-EMAIL_VERIFY_URL = os.getenv("EMAIL_VERIFY_URL") or ""
-SECRET = get_secret("SECRET") or None
+PASSWORD_RESET_URL = get_os_env("PASSWORD_RESET_URL", "")
+EMAIL_VERIFY_URL = get_os_env("EMAIL_VERIFY_URL", "")
+SECRET = get_secret("SECRET")
 
 REGISTRATION_ENABLED = settings_bool("REGISTRATION_ENABLED", default=True)
 REGISTRATION_ADMIN_APPROVAL = settings_bool("REGISTRATION_ADMIN_APPROVAL", default=False)
@@ -50,6 +55,6 @@ REGISTRATION_ADMIN_APPROVAL = settings_bool("REGISTRATION_ADMIN_APPROVAL", defau
 CREATE_INDEXES_WITH_PROJECT = settings_bool("CREATE_INDEXES_WITH_PROJECT", default=True)
 
 DEBUG = settings_bool("DEBUG", default=False)
-PANDAHUB_SERVER_URL = os.getenv("PANDAHUB_SERVER_URL", "0.0.0.0")
-PANDAHUB_SERVER_PORT = int(os.getenv('PANDAHUB_SERVER_PORT', 8002))
-WORKERS = int(os.getenv('WORKER', 2))
+PANDAHUB_SERVER_URL = get_os_env("PANDAHUB_SERVER_URL", "0.0.0.0")
+PANDAHUB_SERVER_PORT = int(get_os_env('PANDAHUB_SERVER_PORT', 8002))
+WORKERS = int(get_os_env('WORKER', 2))

{pandahub-0.3.5 → pandahub-0.3.6}/pandahub/api/main.py

@@ -61,7 +61,7 @@ async def ready():
 
 
 if __name__ == "__main__":
-    uvicorn.run("main:app",
+    uvicorn.run("pandahub.api.main:app",
                 host=settings.PANDAHUB_SERVER_URL,
                 port=settings.PANDAHUB_SERVER_PORT,
                 log_level="info",

{pandahub-0.3.5 → pandahub-0.3.6}/pandahub/lib/PandaHub.py

@@ -234,14 +234,11 @@ class PandaHub:
             project_data["_id"] = project_id
         if self.user_id is not None:
             project_data["users"] = {self.user_id: "owner"}
-        id = self.mongo_client["user_management"]["projects"].insert_one(project_data).inserted_id
+        self.mongo_client["user_management"]["projects"].insert_one(project_data)
         if CREATE_INDEXES_WITH_PROJECT:
             self._create_mongodb_indexes(project_data["_id"])
         if activate:
-            if "_id" in project_data.keys():
-                id = project_data["_id"]
-
-            self.set_active_project_by_id(id)
+            self.set_active_project_by_id(project_data["_id"])
         return project_data
 
     def delete_project(self, i_know_this_action_is_final=False, project_id=None):
@@ -257,15 +254,16 @@ class PandaHub:
         self.mongo_client.user_management.projects.delete_one({"_id": project_id})
         self.active_project = None
 
-    def get_projects(self):
+    def get_projects(self, realm: Optional[str] = None):
+        filter_dict = {}
         if self.user_id is not None:
             user = self._get_user()
-            if user["is_superuser"]:
-                filter_dict = {}
-            else:
+            if not user["is_superuser"]:
                 filter_dict = {"users.{}".format(self.user_id): {"$exists": True}}
         else:
             filter_dict = {"users": {"$exists": False}}
+        if realm is not None:
+            filter_dict["realm"] = realm
         db = self.mongo_client["user_management"]
         projects = list(db["projects"].find(filter_dict))
         return [
@@ -287,7 +285,7 @@ class PandaHub:
         ]
 
     def set_active_project(self, project_name:str, realm=None):
-        projects = self.get_projects()
+        projects = self.get_projects(realm=realm)
         active_projects = [
             project for project in projects if project["name"] == project_name
         ]
@@ -459,7 +457,7 @@ class PandaHub:
         """
         if not self.active_project:
             raise PandaHubError("No project activated!")
-        return self.get_project_database("_network").find({}, {"_id:": 1}).distinct("_id")
+        return self.get_project_database("_networks").find({}, {"_id:": 1}).distinct("_id")
 
     def get_project_version(self):
         return self.active_project.get("version", "0.2.2")
@@ -469,6 +467,9 @@ class PandaHub:
         # TODO these operations should be encapsulated in a transaction in order to avoid
         #      inconsistent Database states in case of occuring errors
 
+        if self.active_project["version"] == __version__:
+            return
+
         if version.parse(self.get_project_version()) < version.parse("0.2.3"):
             db = self._get_project_database()
             all_collection_names = db.list_collection_names()
@@ -482,9 +483,6 @@ class PandaHub:
 
             for element in old_net_collections:
                 db[element].rename(self._collection_name_of_element(element))
-
-        if version.parse(self.get_project_version()) < version.parse("0.2.3"):
-            db = self._get_project_database()
             # for all networks
             for d in list(
                 db["_networks"].find({}, projection={"sector": 1, "data": 1})
@@ -504,17 +502,17 @@ class PandaHub:
                     except:
                         dat = f"serialized_{json.dumps(data, cls=io_pp.PPJSONEncoder)}"
                     data[key] = dat
-
                 db["_networks"].update_one({"_id": d["_id"]}, {"$set": {"data": data}})
 
+            logger.info(
+                f"upgraded projekt '{self.active_project['name']}' from version"
+                f" {self.get_project_version()} to version 0.2.3"
+            )
+
         project_collection = self.mongo_client["user_management"].projects
         project_collection.update_one(
             {"_id": self.active_project["_id"]}, {"$set": {"version": __version__}}
         )
-        logger.info(
-            f"upgraded projekt '{self.active_project['name']}' from version"
-            f" {self.get_project_version()} to version {__version__}"
-        )
         self.active_project["version"] = __version__
 
     # -------------------------

{pandahub-0.3.5 → pandahub-0.3.6}/pandahub.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pandahub
-Version: 0.3.5
+Version: 0.3.6
 Summary: Data hub for pandapower and pandapipes networks based on MongoDB
 Author-email: Jan Ulffers <jan.ulffers@iee.fraunhofer.de>, Leon Thurner <leon.thurner@retoflow.de>, Jannis Kupka <jannis.kupka@retoflow.de>, Mike Vogt <mike.vogt@iee.fraunhofer.de>, Joschka Thurner <joschka.thurner@retoflow.de>, Alexander Scheidler <alexander.scheidler@iee.fraunhofer.de>
 License: Copyright (c) 2022 by University of Kassel, Fraunhofer Institute for Energy Economics
@@ -58,80 +58,20 @@ Provides-Extra: docs
 Provides-Extra: test
 Provides-Extra: all
 License-File: LICENSE
-License-File: AUTHORS
 
 [![pandapower](https://www.pandapower.org/images/pp.svg)](https://www.pandapower.org)         [![pandapipes](https://www.pandapipes.org/images/pp.svg)](https://www.pandapipes.org)
 
 [![pandahub](https://badge.fury.io/py/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/pypi/pyversions/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/e2nIEE/pandahub/blob/master/LICENSE)
 
+pandahub is a data hub for pandapower and pandapipes networks based on MongoDB. It allows you to store pandapower and
+pandapipes networks as well as timeseries in a MongoDB. pandahub allows you to access the database directly through the PandaHub class,
+but also provides a REST-API based on FastAPI. Access through the API is managed with a user management implementation based on FastAPI Users.
 
-pandahub is a data hub for pandapower and pandapipes networks based on MongoDB. It allows you to store pandapower and pandapipes networks as well as timeseries in a MongoDB. pandahub allows you to access the database directly for local development, but also includes a client/server architecture that exposes all relevant methods as an API based on FastAPI. Access through the API is managed with a user management implementation based on FastAPI Users.
+## Development
+`docker compose up -d` runs a mongodb container alongside a pandahub api instance with live reload available
+at http://localhost:8002. To connect to an existing database instead, set `MONGODB_URL` to the connection string through an environment variable / in you `.env` file.
 
-## Setup a local pandahub api
+Swagger UI is available at http://localhost:8002/docs.
 
-Steps to test the client/server structure locally:
-
-1. Start a MongoDB on localhost:27017 (or another custom port)
-
-2. Start the uvicorn server that exposes the API by navigating to "pandahub/api" and running:
-
-   ```
-   # windows
-   set SECRET=secret & python main.py
-
-   # linux
-   SECRET=secret python main.py
-   ```
-
-   or if you don't run mongodb on the default port (27017)
-
-   ```
-   # windows
-   set MONGODB_URL=mongodb://localhost:[mongo-port] & set SECRET=secret & python main.py
-
-   # linux
-   MONGODB_URL=mongodb://localhost:[mongo-port] SECRET=secret python main.py
-   ```
-
-   The API should now run on http://localhost:8002
-
-   >**Note**
-   >A full documentation of all api endpoints can be seen at http://localhost:8002/docs
-
-   >**Note 2**
-   >You can avoid always setting the environment variables for SECRET and MONGODB_URL by creating an `.env` file in `pandahub/api/` with the following content:
-   >```
-   >SECRET=secret
-   >MONGODB_URL=mongodb://localhost:[mongo-port]
-   >```
-
-## Develop with Docker
-
-`docker compose up` starts a mongodb container alongside pandahub with live reload available at http://localhost:8002.
-
-If you want to connect to a running database, set the database url and specify only docker-compose.yml:
-
-    MONGODB_URL=mongodb://localhost:[mongo-port] docker compose -f docker-compose.yml up
-
-
-
-## Use pandahub api with pandahub client
-
-1. Login with the pandahub client
-
-   There are two ways to login with pandahub client
-
-   - If you installed pandahub by pip or with setup.py just run `pandahub-login` in your shell.
-
-   OR
-
-   - Run the following in your python or IPython shell:
-
-   ```
-   from pandahub.client.user_management import login
-   login()
-   ```
-
-   This will guide you through the login process.
-
-2. You only need to login once. After you logged in successfully a configuration file (pandahub.config) containing an authentication token is created in your home directory and will be used every time you use the pandahub client. You only need to login again if you want to use a different instance of the pandahub api.
+If you develop on the library and do not need the fastapi app, `docker compose up db -d` starts only the mongodb
+container.

{pandahub-0.3.5 → pandahub-0.3.6}/pandahub.egg-info/SOURCES.txt

@@ -1,10 +1,10 @@
-AUTHORS
 CHANGELOG.md
 CONTRIBUTING.rst
 LICENSE
 MANIFEST.in
 README.md
 pyproject.toml
+requirements.txt
 setup.py
 pandahub/__init__.py
 pandahub.egg-info/PKG-INFO
@@ -28,9 +28,6 @@ pandahub/api/routers/projects.py
 pandahub/api/routers/timeseries.py
 pandahub/api/routers/users.py
 pandahub/api/routers/variants.py
-pandahub/client/PandaHubClient.py
-pandahub/client/__init__.py
-pandahub/client/user_management.py
 pandahub/lib/PandaHub.py
 pandahub/lib/__init__.py
 pandahub/lib/database_toolbox.py
@@ -40,11 +37,11 @@ pandahub/lib/timeseries/__init__.py
 pandahub/lib/timeseries/output_writer_mongodb.py
 pandahub/lib/timeseries/data_sources/__init__.py
 pandahub/lib/timeseries/data_sources/mongo_data.py
-pandahub/test/__init__.py
-pandahub/test/conftest.py
-pandahub/test/performance_test.py
-pandahub/test/test_client.py
-pandahub/test/test_networks.py
-pandahub/test/test_projects.py
-pandahub/test/test_timeseries.py
+test/__init__.py
+test/conftest.py
+test/performance_test.py
+test/test_client.py
+test/test_networks.py
+test/test_projects.py
+test/test_timeseries.py
 tutorials/config.py

{pandahub-0.3.5 → pandahub-0.3.6}/pandahub.egg-info/requires.txt

@@ -1,19 +1,3 @@
-uvicorn>=0.24.0
-fastapi-users[beanie]>=12.0
-fastapi>=0.104.0
-fastapi-mail>=1.4.1
-pandapower~=2.14
-pandapipes>=0.7.0
-pymongo
-pydantic
-simplejson
-requests<2.28.0
-python-dotenv
-pymongoarrow
-blosc
-motor<3.0.0
-hypothesis-graphql<0.10.0
-attrs>=22.2.0
 
 [all]
 numpydoc
@@ -21,7 +5,7 @@ sphinx
 sphinx_rtd_theme
 sphinxcontrib.bibtex
 sphinx-pyproject
-pytest<8.0.0
+pytest
 pytest-xdist
 nbmake
 simbench

{pandahub-0.3.5 → pandahub-0.3.6}/pandahub.egg-info/top_level.txt

@@ -1,2 +1,3 @@
 pandahub
+test
 tutorials

{pandahub-0.3.5 → pandahub-0.3.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pandahub"
-version = "0.3.5"  # File format version '__format_version__' is tracked in __init__.py
+version = "0.3.6"  # File format version '__format_version__' is tracked in __init__.py
 authors=[
     { name = "Jan Ulffers", email = "jan.ulffers@iee.fraunhofer.de" },
     { name = "Leon Thurner", email = "leon.thurner@retoflow.de" },
@@ -35,24 +35,6 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12"
 ]
-dependencies = [
-    "uvicorn>=0.24.0",
-    "fastapi-users[beanie]>=12.0",
-    "fastapi>=0.104.0",
-    "fastapi-mail>=1.4.1",
-    "pandapower~=2.14",
-    "pandapipes>=0.7.0",
-    "pymongo",
-    "pydantic",
-    "simplejson",
-    "requests<2.28.0",
-    "python-dotenv",
-    "pymongoarrow",
-    "blosc",
-    "motor<3.0.0",
-    "hypothesis-graphql<0.10.0",
-    "attrs>=22.2.0"
-]
 keywords = [
     "network", "analysis", "optimization", "automation", "grid", "energy", "engineering", "simulation",
 ]
@@ -66,12 +48,15 @@ Issues = "https://github.com/e2nIEE/pandahub/issues"
 Download = "https://pypi.org/project/pandahub/#files"
 Changelog = "https://github.com/e2nIEE/pandahub/blob/develop/CHANGELOG.md"
 
+[tool.setuptools.dynamic]
+dependencies = { file = ["requirements.txt"] }
+
 [project.optional-dependencies]
 docs = ["numpydoc", "sphinx", "sphinx_rtd_theme", "sphinxcontrib.bibtex", "sphinx-pyproject"]
 test = ["pytest", "pytest-xdist", "nbmake", "simbench", "line_profiler"]
 all = [
     "numpydoc", "sphinx", "sphinx_rtd_theme", "sphinxcontrib.bibtex", "sphinx-pyproject",
-    "pytest<8.0.0", "pytest-xdist", "nbmake", "simbench", "line_profiler",
+    "pytest", "pytest-xdist", "nbmake", "simbench", "line_profiler",
 ]
 
 [tool.setuptools.packages]

pandahub-0.3.6/requirements.txt

@@ -0,0 +1,13 @@
+uvicorn>=0.24.0
+fastapi-users[beanie]>=12.0
+fastapi>=0.104.0
+fastapi-mail>=1.4.1
+pandapower~=2.14
+pandapipes>=0.7.0
+pymongo
+pydantic
+simplejson
+requests
+python-dotenv
+pymongoarrow
+blosc

pandahub-0.3.6/test/conftest.py

@@ -0,0 +1,21 @@
+import pytest
+from pandahub import PandaHub
+from pandahub.api.internal import settings
+
+@pytest.fixture(scope="session")
+def ph():
+    ph = PandaHub(connection_url=settings.MONGODB_URL)
+
+    project_name = "pytest"
+
+    if ph.project_exists(project_name):
+        ph.set_active_project(project_name)
+        ph.delete_project(i_know_this_action_is_final=True)
+
+    ph.create_project(name=project_name)
+
+    yield ph
+
+    ph.delete_project(i_know_this_action_is_final=True)
+
+

pandahub-0.3.5/AUTHORS

@@ -1,6 +0,0 @@
-- Jan Ulffers
-- Mike Vogt
-- Leon Thurner
-- Jannis Kupka
-- Joschka Thurner
-- Alexander Scheidler

pandahub-0.3.5/README.md

@@ -1,75 +0,0 @@
-[![pandapower](https://www.pandapower.org/images/pp.svg)](https://www.pandapower.org)         [![pandapipes](https://www.pandapipes.org/images/pp.svg)](https://www.pandapipes.org)
-
-[![pandahub](https://badge.fury.io/py/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/pypi/pyversions/pandahub.svg)](https://pypi.org/project/pandahub/) [![pandahub](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/e2nIEE/pandahub/blob/master/LICENSE)
-
-
-pandahub is a data hub for pandapower and pandapipes networks based on MongoDB. It allows you to store pandapower and pandapipes networks as well as timeseries in a MongoDB. pandahub allows you to access the database directly for local development, but also includes a client/server architecture that exposes all relevant methods as an API based on FastAPI. Access through the API is managed with a user management implementation based on FastAPI Users.
-
-## Setup a local pandahub api
-
-Steps to test the client/server structure locally:
-
-1. Start a MongoDB on localhost:27017 (or another custom port)
-
-2. Start the uvicorn server that exposes the API by navigating to "pandahub/api" and running:
-
-   ```
-   # windows
-   set SECRET=secret & python main.py
-
-   # linux
-   SECRET=secret python main.py
-   ```
-
-   or if you don't run mongodb on the default port (27017)
-
-   ```
-   # windows
-   set MONGODB_URL=mongodb://localhost:[mongo-port] & set SECRET=secret & python main.py
-
-   # linux
-   MONGODB_URL=mongodb://localhost:[mongo-port] SECRET=secret python main.py
-   ```
-
-   The API should now run on http://localhost:8002
-
-   >**Note**
-   >A full documentation of all api endpoints can be seen at http://localhost:8002/docs
-
-   >**Note 2**
-   >You can avoid always setting the environment variables for SECRET and MONGODB_URL by creating an `.env` file in `pandahub/api/` with the following content:
-   >```
-   >SECRET=secret
-   >MONGODB_URL=mongodb://localhost:[mongo-port]
-   >```
-
-## Develop with Docker
-
-`docker compose up` starts a mongodb container alongside pandahub with live reload available at http://localhost:8002.
-
-If you want to connect to a running database, set the database url and specify only docker-compose.yml:
-
-    MONGODB_URL=mongodb://localhost:[mongo-port] docker compose -f docker-compose.yml up
-
-
-
-## Use pandahub api with pandahub client
-
-1. Login with the pandahub client
-
-   There are two ways to login with pandahub client
-
-   - If you installed pandahub by pip or with setup.py just run `pandahub-login` in your shell.
-
-   OR
-
-   - Run the following in your python or IPython shell:
-
-   ```
-   from pandahub.client.user_management import login
-   login()
-   ```
-
-   This will guide you through the login process.
-
-2. You only need to login once. After you logged in successfully a configuration file (pandahub.config) containing an authentication token is created in your home directory and will be used every time you use the pandahub client. You only need to login again if you want to use a different instance of the pandahub api.

pandahub-0.3.5/pandahub/client/PandaHubClient.py

@@ -1,149 +0,0 @@
-import requests
-import pandapower as pp
-import pandas as pd
-from pathlib import Path
-import os
-import json
-from fastapi.encoders import jsonable_encoder
-
-
-class PandaHubClient:
-    def __init__(self, config=None):
-        d = None
-        if config is None:
-            config = os.path.join(Path.home(), "pandahub.config")
-        elif type(config) == dict:
-            d = config
-
-        try:
-            if d is None:
-                with open(config, "r") as f:
-                    d = json.load(f)
-        except FileNotFoundError:
-            raise UserWarning("No pandahub configuration file found - log in first")
-
-        self.url = d["url"]
-        self.token = d["token"]
-        self.cert = None
-        if d.get("client_cert_path") and d.get("client_key_path"):
-            self.cert = (d["client_cert_path"], d["client_key_path"])
-        self.project_id = None
-
-    def set_active_project(self, project_name):
-        r = self._post("/projects/set_active_project", json=locals())
-        if r.ok:
-            self.project_id = r.json()
-        else:
-            self.project_id = None
-        return r
-
-    ### PROJECT HANDLING
-
-    def create_project(self, name):
-        return self._post("/projects/create_project", json=locals())
-
-    def delete_project(self, i_know_this_action_is_final=False,
-                             error_on_missing_project=True):
-        return self._post("/projects/delete_project", json=locals())
-
-    def project_exists(self, project_name):
-        return self._post("/projects/project_exists", json=locals()).json()
-
-    def get_projects(self):
-        return self._post("/projects/get_projects").json()
-
-    def get_project_settings(self):
-        return self._post("/projects/get_project_settings").json()
-
-    def set_project_settings(self, settings):
-        return self._post("/projects/set_project_settings", json=locals())
-
-    def get_project_metadata(self):
-        return self._post("/projects/get_project_metadata").json()
-
-    def set_project_metadata(self, metadata):
-        return self._post("/projects/set_project_metadata", json=locals())
-
-    ### NET HANDLING
-
-    def write_network_to_db(self, net, name, overwrite=True):
-        json = locals()
-        json["net"] = pp.to_json(net)
-        return self._post("/net/write_network_to_db", json=json)
-
-    def get_net_from_db(self, name, include_results=True, only_tables=None):
-        r = self._post("/net/get_net_from_db", json=locals())
-        return pp.from_json_string(r.json())
-
-
-    ### ELEMENT HANDLING
-
-    def get_net_value_from_db(self, net_name, element, element_index, parameter):
-        return self._post("/net/get_net_value_from_db", json=locals()).json()
-
-    def set_net_value_in_db(self, net_name, element_type, element_index, parameter, value):
-        return self._post("/net/set_net_value_in_db", json=locals())
-
-    def create_element(self, net, element_type, element_index, element_data):
-        return self._post("/net/create_element", json=locals())
-
-    def create_elements(self, net, element_type, elements_data):
-        return self._post("/net/create_elements", json=locals())
-
-    def delete_element(self, net, element_type, element_index):
-        return self._post("/net/delete_element", json=locals())
-
-    def delete_elements(self, net, element_type, element_index):
-        return self._post("/net/delete_elements", json=locals())
-
-
-    ### deprecated functions
-
-    def create_element_in_db(self, *args, **kwargs):
-        raise RuntimeError("create_element_in_db was deprecated - use create_element instead!")
-
-    def create_elements_in_db(self, *args, **kwargs):
-        raise RuntimeError("ph.create_elements_in_db was deprecated - use ph.create_elements instead! "
-                      "Watch out for changed order of project_id and variant args")
-
-    def delete_net_element(self, *args, **kwargs):
-        raise RuntimeError("ph.delete_net_element was deprecated - use ph.delete_element instead!")
-
-
-    ### TIMESERIES
-
-    def multi_get_timeseries_from_db(self, filter_document={}, timestamp_range=None,
-                                    exclude_timestamp_range=None,
-                                    global_database=False):
-        ts = self._post("/timeseries/multi_get_timeseries_from_db", json=locals()).json()
-        for i, data in enumerate(ts):
-            ts[i]["timeseries_data"] = pd.Series(json.loads(data["timeseries_data"]))
-        return ts
-
-    def get_timeseries_from_db(self, filter_document={}, timestamp_range=None,
-                                    exclude_timestamp_range=None,
-                                    global_database=False):
-        r = self._post("/timeseries/get_timeseries_from_db", json=locals())
-        return pd.Series(json.loads(r.json()))
-
-    def write_timeseries_to_db(self, timeseries, data_type, element_type=None,
-                               netname=None, element_index=None, name=None,
-                               global_database=False, collection_name="timeseries"):
-        json = locals()
-        json["timeseries"] = json["timeseries"].to_json(date_format="iso")
-        return self._post("/timeseries/write_timeseries_to_db", json=json)
-
-
-
-    ### INTERNAL
-
-    def _post(self, path, json=None, authorize=True):
-        headers = {'Authorization': 'Bearer {}'.format(self.token)} if authorize else None
-        path = self.url + path
-        if json is None:
-            json = {}
-        if json is not None and "self" in json:
-            del json['self']
-        json = jsonable_encoder(json)
-        json["project_id"] = self.project_id
-        return requests.post(path, headers=headers, json=json, cert=self.cert)

pandahub-0.3.5/pandahub/client/user_management.py

@@ -1,56 +0,0 @@
-import os
-from pathlib import Path
-import requests
-import json
-import getpass
-
-config_file = os.path.join(Path.home(), "pandahub.config")
-
-def login():
-    url = input("Enter pandahub URL: ")
-    cert_path = None
-    key_path = None
-
-    # ask for client certificates
-    while(True):
-        with_client_ssl = input("Certificate for API needed? (y/n): ")
-        if with_client_ssl != "y" and with_client_ssl != "n":
-            print("ERROR: Wrong input! Only 'y' or 'n' are accepted!")
-        else:
-            if with_client_ssl == "y":
-                cert_path = input("Path to client certificate (*.crt): ")
-                key_path = input("Path to client key (*.key): ")
-            break
-
-    email = input("Enter E-Mail: ")
-    password = getpass.getpass("Enter Password: ")
-    _login(url, email, password, cert_path, key_path)
-
-def _login(url, email, password, cert_path=None, key_path=None):
-    path = url + "/auth/login"
-
-    cert = None
-    if cert_path and key_path:
-        cert = (cert_path, key_path)
-
-    r = requests.post(path, data={"username": email, "password": password}, cert=cert)
-
-    if r.status_code == 200:
-        token = r.json()["access_token"]
-        write_config(url, token, cert_path, key_path)
-    elif r.status_code == 400:
-        if "required SSL certificate" in r.text:
-            print("Login failed - no client certificate provided")
-        else:
-            print("Login failed - bad credentials.")
-    else:
-        print(f"[ERROR] code: {r.status_code}, reason: {r.reason}")
-
-def write_config(url, token, cert_path="", key_path=""):
-    with open(config_file, "w") as f:
-        json.dump({
-            "url": url,
-            "token": token,
-            "client_cert_path": cert_path,
-            "client_key_path": key_path
-        }, f)

pandahub-0.3.5/pandahub/test/conftest.py

@@ -1,49 +0,0 @@
-import pytest
-from pandahub import PandaHub
-from pandahub import PandaHubClient
-from pandahub.api.internal import settings
-
-@pytest.fixture(scope="session")
-def ph():
-    ph = PandaHub(connection_url=settings.MONGODB_URL)
-
-    project_name = "pytest"
-
-    if ph.project_exists(project_name):
-        ph.set_active_project(project_name)
-        ph.delete_project(i_know_this_action_is_final=True)
-
-    ph.create_project(name=project_name, activate=False)
-    ph.set_active_project(project_name)
-
-    yield ph
-
-    ph.delete_project(i_know_this_action_is_final=True)
-
-
-@pytest.fixture(scope="session")
-def phc():
-    url = settings.PANDAHUB_SERVER_URL
-
-    if url == "0.0.0.0":
-        url = "127.0.0.1"
-
-    phc = PandaHubClient(
-        config={
-            "url": f"http://{url}:{settings.PANDAHUB_SERVER_PORT}",
-            "token": settings.SECRET
-        }
-    )
-
-    project_name = "pandahubclienttest"
-
-    #if phc.project_exists(project_name):
-    #    phc.set_active_project(project_name)
-    #    phc.delete_project(i_know_this_action_is_final=True)
-
-    phc.create_project(name=project_name)
-    phc.set_active_project(project_name)
-
-    yield phc
-
-    phc.delete_project(i_know_this_action_is_final=True)

pandahub-0.3.5/pandahub/test/test_client.py

@@ -1,23 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from pandahub import PandaHubClient
-import pandapower.networks as nw
-
-
-def test_client_io(phc: PandaHubClient):
-    phc.set_active_project("Manderbach")
-
-    net = nw.mv_oberrhein()
-    phc.write_network_to_db(net, name='mv_oberrhein', overwrite=True)
-    net_loaded = phc.get_net_from_db(name='mv_oberrhein')
-
-    assert len(net_loaded) != 0
-
-
-if __name__ == '__main__':
-    phc = PandaHubClient()
-    phc.set_active_project("Manderbach")
-    net = phc.get_net_from_db("power")
-
-    ts = phc.multi_get_timeseries_from_db({"name": "H0"}, global_database=True)
-    phc.write_timeseries_to_db(ts[0]["timeseries_data"], "p_mw", "sgen")