ecodev-core 0.0.3__tar.gz → 0.0.4__tar.gz

{ecodev_core-0.0.3 → ecodev_core-0.0.4}/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2024 Thomas EPELBAUM
+Copyright 2024 Thomas EPELBAUM for EcoAct
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction,
 including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,

{ecodev_core-0.0.3 → ecodev_core-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ecodev-core
-Version: 0.0.3
+Version: 0.0.4
 Summary: Low level sqlmodel/fastapi/pydantic building blocks
 License: MIT
 Author: Thomas Epelbaum
@@ -71,3 +71,7 @@ Starting from a project with a Docker file:
 * build the new version of the Docker container (typically `docker build --tag xxx .`)
 * run it with docker compose (`dc up -d`).
 
+## Documentation
+
+Please find it in the [associated mkdoc website!](https://ecodev-doc.lcabox.com/)
+

{ecodev_core-0.0.3 → ecodev_core-0.0.4}/README.md

@@ -23,3 +23,7 @@ Starting from a project with a Docker file:
 * make sure the `.env` file includes all required fields (see `BaseSettings` and `AuthenticationConfiguration`)
 * build the new version of the Docker container (typically `docker build --tag xxx .`)
 * run it with docker compose (`dc up -d`).
+
+## Documentation
+
+Please find it in the [associated mkdoc website!](https://ecodev-doc.lcabox.com/)

{ecodev_core-0.0.3 → ecodev_core-0.0.4}/ecodev_core/__init__.py

@@ -20,6 +20,7 @@ from ecodev_core.authentication import is_admin_user
 from ecodev_core.authentication import is_authorized_user
 from ecodev_core.authentication import is_monitoring_user
 from ecodev_core.authentication import JwtAuth
+from ecodev_core.authentication import safe_get_user
 from ecodev_core.authentication import SCHEME
 from ecodev_core.authentication import Token
 from ecodev_core.check_dependencies import check_dependencies
@@ -75,5 +76,4 @@ __all__ = [
     'enum_converter', 'ServerSideFilter', 'get_rows', 'count_rows', 'ServerSideField', 'get_raw_df',
     'generic_insertion', 'custom_equal', 'is_authorized_user', 'get_method', 'AppActivity',
     'fastapi_monitor', 'dash_monitor', 'is_monitoring_user', 'get_recent_activities', 'select_user',
-    'get_access_token'
-]
+    'get_access_token', 'safe_get_user']

{ecodev_core-0.0.3 → ecodev_core-0.0.4}/ecodev_core/authentication.py

@@ -148,6 +148,16 @@ def is_authorized_user(token: str = Depends(SCHEME)) -> bool:
         return False
 
 
+def safe_get_user(token: Dict) -> Union[AppUser, None]:
+    """
+    Safe method returning a user if one found given the passed token
+    """
+    try:
+        return get_user(get_access_token(token))
+    except (HTTPException, AttributeError):
+        return None
+
+
 def get_user(token: str = Depends(SCHEME)) -> AppUser:
     """
     Retrieves (if it exists) the db user corresponding to the passed token

{ecodev_core-0.0.3 → ecodev_core-0.0.4}/ecodev_core/db_insertion.py

@@ -37,7 +37,7 @@ class Insertor(CustomFrozen):
         - selector: the criteria on which to decide whether to create or update (example: only add
           a user if a user with the same name is not already present in the db)
         - convertor: how to convert the raw csv/excel passed by the user to json like db rows
-        - whether to insert data based on an xlsx (if true) or a csv (if false)
+        - read_excel_file: whether to insert data based on an xlsx (if true) or a csv (if false)
     """
     reductor: Callable[[Any, Any], Any]
     db_schema: Callable

{ecodev_core-0.0.3 → ecodev_core-0.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ecodev-core"
-version = "0.0.3"
+version = "0.0.4"
 description = "Low level sqlmodel/fastapi/pydantic building blocks"
 authors = ["Thomas Epelbaum <tomepel@gmail.com>",
 					 "Olivier Gabriel <olivier.gabriel.geom@gmail.com>",