diff --git a/README.md b/README.md index b42ae46..224326c 100644 --- 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 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