Cleaned up

Author: MrMatAP

.github/workflows/build.yml

@@ -70,9 +70,7 @@ jobs:
     - name: Build
       run: |
         export PYTHONUSERBASE=${HOME}/.local
-        pip install --user wheel
-        pip install --user -r requirements.txt
-        ${PYTHONUSERBASE}/bin/pylint ${GITHUB_WORKSPACE}/mrmat_python_api_fastapi
+        pip install --user -r requirements.txt -r requirements.dev.txt
         PYTHONPATH=${GITHUB_WORKSPACE} python -m pytest --cov=mrmat_python_api_fastapi
         PYTHONPATH=${GITHUB_WORKSPACE} python -m build --wheel -n
 

.idea/mrmat-python-api-fastapi.iml

@@ -38,7 +38,7 @@
             summary='List all known resources',
             description='Returns all currently known resources and their metadata',
             response_model=List[ResourceSchema])
-async def get_all(db: Session = Depends(get_db)):
+async def get_resources(db: Session = Depends(get_db)):
     return db.query(Resource).all()
 
 
@@ -47,7 +47,7 @@ async def get_all(db: Session = Depends(get_db)):
             summary='Get a single resource',
             description='Return a single resource identified by its resource id',
             response_model=Union[ResourceSchema, StatusSchema])
-async def get(identity: int, db: Session = Depends(get_db)):
+async def get_resource(identity: int, db: Session = Depends(get_db)):
     resource = db.query(Resource).get(identity).one_or_none()
     if not resource:
         return JSONResponse(status_code=404,
@@ -60,7 +60,7 @@ async def get(identity: int, db: Session = Depends(get_db)):
              summary='Create a resource',
              description='Create a resource owned by the authenticated user',
              response_model=Union[ResourceSchema, StatusSchema])
-async def create(data: ResourceInputSchema, db: Session = Depends(get_db)):
+async def create_resource(data: ResourceInputSchema, db: Session = Depends(get_db)):
     resource = Resource(name=data.name)
     db.add(resource)
     db.commit()
@@ -72,7 +72,7 @@ async def create(data: ResourceInputSchema, db: Session = Depends(get_db)):
             summary='Modify a resource',
             description='Modify a resource by its resource id',
             response_model=Union[ResourceSchema, StatusSchema])
-async def modify(identity: int, data: ResourceInputSchema, db: Session = Depends(get_db)):
+async def modify_resource(identity: int, data: ResourceInputSchema, db: Session = Depends(get_db)):
     resource = db.query(Resource).get(identity)
     if not resource:
         return JSONResponse(status_code=404,
@@ -92,7 +92,7 @@ async def modify(identity: int, data: ResourceInputSchema, db: Session = Depends
                    status.HTTP_204_NO_CONTENT: {'description': 'The resource was removed'},
                    status.HTTP_410_GONE: {'description': 'The resource was already gone'}
                })
-async def remove(identity: int, response: Response, db: Session = Depends(get_db)):
+async def remove_resource(identity: int, response: Response, db: Session = Depends(get_db)):
     resource = db.query(Resource).get(identity)
     if not resource:
         return JSONResponse(status_code=204,
@@ -109,7 +109,7 @@ async def remove(identity: int, response: Response, db: Session = Depends(get_db
             summary='List all known owners',
             description='Returns all currently known owners and their metadata',
             response_model=List[OwnerSchema])
-async def get_all(db: Session = Depends(get_db)):
+async def get_owners(db: Session = Depends(get_db)):
     return db.query(Owner).all()
 
 
@@ -118,7 +118,7 @@ async def get_all(db: Session = Depends(get_db)):
             summary='Get a single owner',
             description='Return a single owner identified by its owner id',
             response_model=Union[OwnerSchema, StatusSchema])
-async def get(identity: int, db: Session = Depends(get_db)):
+async def get_owner(identity: int, db: Session = Depends(get_db)):
     owner = db.query(Owner).get(identity)
     if not owner:
         return JSONResponse(status_code=404,
@@ -131,7 +131,7 @@ async def get(identity: int, db: Session = Depends(get_db)):
              summary='Create a owner',
              description='Create a owner',
              response_model=Union[OwnerSchema, StatusSchema])
-async def create(data: OwnerInputSchema, db: Session = Depends(get_db)):
+async def create_owner(data: OwnerInputSchema, db: Session = Depends(get_db)):
     owner = Owner(name=data.name, client_id='TODO')
     db.add(owner)
     db.commit()
@@ -143,7 +143,7 @@ async def create(data: OwnerInputSchema, db: Session = Depends(get_db)):
             summary='Modify a owner',
             description='Modify a owner by its owner id',
             response_model=Union[OwnerSchema, StatusSchema])
-async def modify(identity: int, data: ResourceInputSchema, db: Session = Depends(get_db)):
+async def modify_owner(identity: int, data: ResourceInputSchema, db: Session = Depends(get_db)):
     owner = db.query(Owner).get(identity)
     if not owner:
         return JSONResponse(status_code=404,
@@ -163,7 +163,7 @@ async def modify(identity: int, data: ResourceInputSchema, db: Session = Depends
                    status.HTTP_204_NO_CONTENT: {'description': 'The owner was removed'},
                    status.HTTP_410_GONE: {'description': 'The owner was already gone'}
                })
-async def remove(identity: int, response: Response, db: Session = Depends(get_db)):
+async def remove_owner(identity: int, response: Response, db: Session = Depends(get_db)):
     owner = db.query(Owner).get(identity)
     if not owner:
         response.status_code = status.HTTP_410_GONE

.idea/runConfigurations/lint.xml

@@ -23,7 +23,7 @@
 from sqlalchemy import ForeignKey, Column, Integer, String, UniqueConstraint, BigInteger
 from sqlalchemy.orm import relationship
 
-from src.mrmat_python_api_fastapi import Base
+from mrmat_python_api_fastapi import Base
 
 
 class Owner(Base):

src/mrmat_python_api_fastapi/apis/resource/v1/api.py

@@ -20,7 +20,6 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 
-from typing import Optional
 import os
 import json
 import secrets
@@ -34,11 +33,11 @@ class Config:
     db_url: str = 'sqlite://'
 
     @staticmethod
-    def from_json_file(file: Optional[os.PathLike] = os.getenv('APP_CONFIG')):
+    def from_json_file(file: str | None = os.getenv('APP_CONFIG')):
         runtime_config = Config()
         if file and os.path.exists(file):
             with open(file, 'r', encoding='UTF-8') as c:
                 file_config = json.load(c)
-            runtime_config.secret_key = file_config.get('secret_key', secrets.token_urlsafe(16))
-            runtime_config.db_url = file_config.get('db_url', 'sqlite://')
+            runtime_config.secret_key = file_config.get_owner('secret_key', secrets.token_urlsafe(16))
+            runtime_config.db_url = file_config.get_owner('db_url', 'sqlite://')
         return runtime_config

src/mrmat_python_api_fastapi/apis/resource/v1/db.py

@@ -24,7 +24,7 @@
 from sqlalchemy import create_engine
 from sqlalchemy.orm import Session, sessionmaker
 
-from src.mrmat_python_api_fastapi import app_config
+from mrmat_python_api_fastapi import app_config
 
 
 @lru_cache