Merge pull request #13 from WFP-VAM/DataBridgesAPI/patch-1

Data bridges api/patch 1
WFP-VAM · Jan 31, 2024 · ee6f111 · ee6f111
2 parents 7d82d71 + 37c849d
commit ee6f111
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -3,7 +3,17 @@ Scripts and applications for testing DataBridges API from the API Gateway
 
 # Getting started
 ## How to install
-You can pip install the package
+You can use pip to install the package:
+```
+pip install databridgesapi@git+https://github.com/WFP-VAM/DataBridgesAPI
+```
+
+If developing the package, use this command from the repo root for a local and editable installation:
+
+```
+pip install -e .
+```
+
 ## Handling credentials
 Create an .env file to be placed in the root directory of your project looking like:
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -30,3 +30,7 @@ dev = ["black", "bumpver", "isort", "pip-tools", "pytest"]
 
 [project.urls]
 Homepage = "https://catalog.api.wfp.org/devportal/apis/be67cddd-0fb8-4461-a91b-6b75f3146568/overview"
+
+[tool.setuptools.packages.find]
+include = ["databridgesapi*"]
+namespaces = false