From 37c849da2e0e21464d435079108fee0046117ee3 Mon Sep 17 00:00:00 2001
From: Paolo Lucchino <paololucchino@gmail.com>
Date: Wed, 3 Jan 2024 09:34:57 +0100
Subject: [PATCH] Docs for editable installation; bugfix in install from github
 command

---
 README.md      | 9 ++++++++-
 pyproject.toml | 4 ++++
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f1da8ea..224326c 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,15 @@ Scripts and applications for testing DataBridges API from the API Gateway
 ## How to install
 You can use pip to install the package:
 ```
-pip install pip@git+https://github.com/WFP-VAM/DataBridgesAPI
+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
index ccf2631..560bb2e 100644
--- 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
\ No newline at end of file