@@ -25,6 +25,10 @@ There are 2 types of clients:
2525The ` reset_account ` and ` transfer_account_rights ` from the Admin client needs a valid Bitwarden client to re-invite the
2626target user.
2727
28+ ## Installation
29+ ``` bash
30+ pip install python-vaultwarden
31+ ```
2832## Usage
2933
3034### Admin client
@@ -76,15 +80,6 @@ if my_user:
7680
7781```
7882
79- ## TODO
80- - [ ] Add tests form Vaultwarden admin client
81- - [ ] Rewrite crypto part to remove dependency on bitwardentools and add argon2id support
82- - [ ] Support email + password authentication
83- - [ ] Support end user operations
84- - [ ] Ciphers management support
85- - [ ] Many other things I didn't think of yet
86-
87-
8883## Credits
8984
9085The [ crypto part] ( src/vaultwarden/utils/crypto.py ) originates from [ bitwardentools] ( https://github.com/corpusops/bitwardentools ) .
@@ -101,6 +96,35 @@ The [crypto part](src/vaultwarden/utils/crypto.py) originates from [bitwardentoo
10196[ GHAction-link ] : https://github.com/numberly/python-vaultwarden/actions?query=event%3Apush+branch%3Amain
10297<!-- Links -->
10398
99+
100+ ## Contributing
101+ Thank you for being interested in contributing to ` python-vaultwarden ` . There are many ways you can contribute to the project:
102+ - Try and report bugs/issues you find
103+ - Implement new features
104+ - Review Pull Requests of others
105+ - Write documentation
106+ - Participate in discussions
107+
108+ ### Development
109+ To start developing create a fork of the python-vaultwarden repository on GitHub.
110+
111+ Then clone your fork with the following command replacing YOUR-USERNAME with your GitHub username:
112+
113+ ``` bash
114+ git clone https://github.com/YOUR-USERNAME/python-vaultwarden
115+ ```
116+
117+ You can now install the project and its dependencies using:
118+ ``` bash
119+ pip install -e .[test]
120+ ```
121+ ### Testing
122+ To run the tests, use:
123+
124+ ``` bash
125+ bash tests/e2e/run_tests.sh
126+ ```
127+
104128## License
105129
106130Python-vaultwarden is distributed under the terms of the [ Apache-2.0] ( https://spdx.org/licenses/Apache-2.0.html ) license.
0 commit comments