Skip to content

Commit

Permalink
Docs for editable installation; bugfix in install from github command
Browse files Browse the repository at this point in the history
  • Loading branch information
paololucchino committed Jan 3, 2024
1 parent ef19b99 commit 37c849d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 37c849d

Please sign in to comment.