Skip to content

Commit

Permalink
Update Python README (#563)
Browse files Browse the repository at this point in the history
## Type of change

Fix errors in README and update the Python package name in preparation
for publishing to PyPI.

- [ ] Bug fix
- [ ] New feature development
- [ ] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
- [ ] Build/deploy pipeline (DevOps)
- [x] Other

## Before you submit

- Please add **unit tests** where it makes sense to do so
  • Loading branch information
tangowithfoxtrot authored Jan 31, 2024
1 parent 8c6b215 commit 872a05b
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions languages/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Requirements

- Python 3
- `maturin` (install with `pip install maturin[patchelf]`)
- `maturin` (install with `pip install maturin`)
- `npm`

## Build
Expand All @@ -15,12 +15,15 @@ cd languages/python/
maturin develop
```

You can now import `BitwardenClient` in your Python code.
You can now import `BitwardenClient` in your Python code with:
```python
from bitwarden_sdk import BitwardenClient
```

# Use without building locally

```bash
pip install BitwardenClient
pip install bitwarden-sdk
```

# Run
Expand Down

0 comments on commit 872a05b

Please sign in to comment.