From a0cc7a742bebfae69eef5fea000369ed4a9532e3 Mon Sep 17 00:00:00 2001 From: Kumi Date: Thu, 25 Apr 2024 08:58:31 +0200 Subject: [PATCH] feat: optimize pdoc workflow and deps installation Reworked the Python dependency installation step in the `.forgejo/workflows/pdoc.yml` workflow file to install from the current directory (`.`) instead of specifying packages directly. This adjustment ensures that local package dependencies are correctly resolved and installed, aligning with best practices for Python projects. Additionally, streamlined the documentation generation process by modifying the `pdoc` execution command to use the package's dot notation, improving clarity and consistency in how the `pdoc` tool is invoked for generating Markdown documentation. This change enhances the maintainability of our documentation workflow and ensures that our environment mirrors production more closely, potentially reducing the occurrence of "works on my machine" issues. --- .forgejo/workflows/pdoc.yml | 4 ++-- .gitignore | 3 ++- src/plankapy/plankapy.py | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.forgejo/workflows/pdoc.yml b/.forgejo/workflows/pdoc.yml index 53b2289..d28ea87 100644 --- a/.forgejo/workflows/pdoc.yml +++ b/.forgejo/workflows/pdoc.yml @@ -26,9 +26,9 @@ jobs: - name: Install Python dependencies run: | - pip install pdoc requests --break-system-packages + pip install pdoc . --break-system-packages - - run: python3 -m pdoc -d markdown -o docs src/plankapy/plankapy.py + - run: python3 -m pdoc -d markdown -o docs plankapy - uses: forgejo/upload-artifact@v4 with: diff --git a/.gitignore b/.gitignore index 381bf0f..3030798 100644 --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,5 @@ # Directories __pycache__/ -venv/ \ No newline at end of file +venv/ +docs/ \ No newline at end of file diff --git a/src/plankapy/plankapy.py b/src/plankapy/plankapy.py index a266cd0..253cd15 100644 --- a/src/plankapy/plankapy.py +++ b/src/plankapy/plankapy.py @@ -264,7 +264,7 @@ class Board(Controller): def get( self, project_name: Optional[str] = None, - board_name: Optionoal[str] = None, + board_name: Optional[str] = None, oid: Optional[str] = None, ) -> dict: """Gets a board by name