Merge pull request #27 from unicef/develop

dev 2 main
unicef · Nov 27, 2024 · 3e14723 · 3e14723
2 parents fb1bcaa + 868d468
commit 3e14723
Show file tree

Hide file tree

Showing 27 changed files with 1,396 additions and 1,641 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -33,9 +33,11 @@ jobs:
       - name: Install mkDocs
         run: |
           sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
-          pip install pdm
-          pdm install          
-          pdm run mkdocs build -d ./docs-output
+          pip install uv
+          export PKG_CONFIG_PATH="/usr/local/lib/pkgconfig:/opt/homebrew/lib/pkgconfig:$PKG_CONFIG_PATH"
+          export DYLD_LIBRARY_PATH="/usr/local/lib:/opt/homebrew/lib:$DYLD_LIBRARY_PATH"
+          uv sync          
+          uv run mkdocs build -d ./docs-output
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@
 __pycache__
 
 !.github
+
+dist/
diff --git a/README.md b/README.md
@@ -5,14 +5,17 @@ This Repo is used to manage the official HOPE documentation
 
 ## Install
 
-    $ pdm install
-    $ pdm venv activate in-project
+    $ uv sync
+    $ uv build
 
 #### Using .envrc
 
 add in your .envrc
 
-    eval $(pdm venv activate in-project)
+    export PKG_CONFIG_PATH="/usr/local/lib/pkgconfig:/opt/homebrew/lib/pkgconfig:$PKG_CONFIG_PATH"
+    export DYLD_LIBRARY_PATH="/usr/local/lib:/opt/homebrew/lib:$DYLD_LIBRARY_PATH"
+    source .venv/bin/activate
+
 
 #### Start
     $ mkdocs build

diff --git a/docs/components/.pages b/docs/components/.pages
@@ -3,8 +3,8 @@ nav:
 
   - Aurora: aurora
   - Kobo: kobo
-  - Payment Gateway: pg
+  - Payment Gateway: pg.md
   - Country Report: reporting
   - Deduplication: hde
   - RapidPro: rapidpro
-#  - workspace.md
+  - Workspace: workspace.md
diff --git a/docs/components/hde/setup.md b/docs/components/hde/setup.md
@@ -5,7 +5,7 @@ tags:
 
 ## Prerequisites
 
-This project utilizes [PDM](https://pdm-project.org/) as the package manager for managing Python dependencies and environments. 
+This project utilizes [UV](https://docs.astral.sh/uv/) as the package manager for managing Python dependencies and environments. 
 
 To successfully set up and run this project, ensure that you have the following components in place:
 

diff --git a/docs/components/index.md b/docs/components/index.md
@@ -18,13 +18,14 @@ systems and platforms, ensuring smooth workflows and easy expansion as your need
 
 - [Country Report](reporting/index.md)
 
-- [Payment Gateway](pg/index.md)
+- [Payment Gateway](pg.md)
 
-- [Country Workspace](workspace/index.md)
+- [Country Workspace](workspace.md)
+
+- [RapidPro](rapidpro/index.md)
 
 - User Management Module  _(not yet released)_
 
-- [RapidPro](rapidpro/index.md)
 
 
 ## Hope supporting libraries

diff --git a/docs/components/pg.md b/docs/components/pg.md
@@ -0,0 +1,8 @@
+# Payment Gateway
+
+The Integration between HOPE and any FSP is performed through a middleware service called Payment Gateway (PG).
+HOPE sends to the PG information regarding Payments through web API.
+Each FSP can have a different way to interact with the payment gateway with though strategy pattern.
+
+<https://unicef.github.io/hope-payment-gateway/>{:target="_blank"}
+
diff --git a/docs/components/pg/.pages b/docs/components/pg/.pages
diff --git a/docs/components/pg/index.md b/docs/components/pg/index.md
diff --git a/docs/components/pg/setup/.pages b/docs/components/pg/setup/.pages
diff --git a/docs/components/pg/setup/docker.md b/docs/components/pg/setup/docker.md
diff --git a/docs/components/pg/setup/index.md b/docs/components/pg/setup/index.md
diff --git a/docs/components/pg/setup/virtualenv.md b/docs/components/pg/setup/virtualenv.md
diff --git a/docs/components/pg/wu/.pages b/docs/components/pg/wu/.pages
diff --git a/docs/components/pg/wu/actions.md b/docs/components/pg/wu/actions.md
diff --git a/docs/components/pg/wu/index.md b/docs/components/pg/wu/index.md
diff --git a/docs/components/pg/wu/statuses.md b/docs/components/pg/wu/statuses.md
diff --git a/docs/components/workspace.md b/docs/components/workspace.md
@@ -0,0 +1,3 @@
+# Country Workspace
+
+<https://unicef.github.io/hope-country-workspace/>{:target="_blank"}
diff --git a/docs/components/workspace/.pages b/docs/components/workspace/.pages
diff --git a/docs/components/workspace/index.md b/docs/components/workspace/index.md
diff --git a/docs/components/workspace/setup.md b/docs/components/workspace/setup.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Country Workspace

		<https://unicef.github.io/hope-country-workspace/>{:target="_blank"}