Skip to content

Commit

Permalink
docs(README): add contributing part
Browse files Browse the repository at this point in the history
  • Loading branch information
THEBAULT Julien committed Sep 17, 2024
1 parent 3d2cd8b commit c6546e7
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 9 deletions.
43 changes: 34 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ There are 2 types of clients:
The `reset_account` and `transfer_account_rights` from the Admin client needs a valid Bitwarden client to re-invite the
target user.

## Installation
```bash
pip install python-vaultwarden
```
## Usage

### Admin client
Expand Down Expand Up @@ -76,15 +80,6 @@ if my_user:

```

## TODO
- [ ] Add tests form Vaultwarden admin client
- [ ] Rewrite crypto part to remove dependency on bitwardentools and add argon2id support
- [ ] Support email + password authentication
- [ ] Support end user operations
- [ ] Ciphers management support
- [ ] Many other things I didn't think of yet


## Credits

The [crypto part](src/vaultwarden/utils/crypto.py) originates from [bitwardentools](https://github.com/corpusops/bitwardentools).
Expand All @@ -101,6 +96,36 @@ The [crypto part](src/vaultwarden/utils/crypto.py) originates from [bitwardentoo
[GHAction-link]: https://github.com/numberly/python-vaultwarden/actions?query=event%3Apush+branch%3Amain
<!-- Links -->


## Contributing

Thank you for being interested in contributing to `python-vaultwarden`. There are many ways you can contribute to the project:
- Try and report bugs/issues you find
- Implement new features
- Review Pull Requests of others
- Write documentation
- Participate in discussions

### Development
To start developing create a fork of the python-vaultwarden repository on GitHub.

Then clone your fork with the following command replacing YOUR-USERNAME with your GitHub username:

```bash
git clone https://github.com/YOUR-USERNAME/python-vaultwarden
```

You can now install the project and its dependencies using:
```bash
pip install -e .[test]
```
### Testing
To run the tests, use:

```bash
bash tests/e2e/run_tests.sh
```

## License

Python-vaultwarden is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ dependencies = [
"pydantic >=2.5.0",
"httpx >=0.24.1",
]
[dev-dependencies]
test = [
"hatch==1.12.0",
"pytest==8.3.3",
]

[tool.hatch.version]
path = "src/vaultwarden/__version__.py"
Expand Down

0 comments on commit c6546e7

Please sign in to comment.