A simple and opensource password manager
Project description
This project is still under construction
Table of Contents
Requirements
- Python3
- Mariadb / MySQL / MongoDB (Optional)
Installation
- Clone this repository
git clone https://github.com/rizwanmustafa/Rizpass.git
cd Rizpass
- Create a new virtual environment in a folder called 'venv' for this project (This will prevent your binary size and compilation time from being too long).
python3 -m venv venv
- Activate the virtual environment:
source venv/bin/activate
- Install the package
pip install .
- Start Rizpass
python3 -m rizpass
Note: You can also start rizpass by executing rizpass
in the terminal directly however this may require modification to the $PATH
variable
Bonus - If you want to do it all in one step:
git clone https://github.com/rizwanmustafa/Rizpass.git
cd Rizpass
python3 -m venv venv
source venv/bin/activate
pip install .
python3 -m rizpass
Configuration
Configuring Rizpass is as simple as running the following command and answering the questions asked
python3 -m rizpass --setup
Configuration File
Rizpass uses a json object for storing its configuration. The setup command creates a configuration file at ~/.rizpass.json
Here is a list of the fields contained in the configuration file and their description:
db_type (string, Required) : Name of the database. 'mysql' for MySQL or MariaDB and 'mongo' for MongoDB.
db_host (string, Required) : Address at which the database is hosted e.g 'localhost'
db_name (string, Required) : Name of the database created specifically for Rizpass to store your credentials in.
db_user (string, Required) : Name of the database user created specifically for Rizpass (Should have read and write permissions on the database).
db_port (integer, Optional): Port number for communication with the database. Defaults to 3306 for 'mysql' and 27017 for 'mongo'.
Sample Configuration File
{"db_type": "mongo", "db_host": "localhost", "db_user": "passMan", "db_name": "rizpass", "db_port": 7000}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
rizpass-0.0.1a0.tar.gz
(29.3 kB
view hashes)
Built Distribution
rizpass-0.0.1a0-py3-none-any.whl
(32.8 kB
view hashes)
Close
Hashes for rizpass-0.0.1a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2156018690c15ab989226c712740252d16d5b64c1c31e913c8cb773fcd66ca87 |
|
MD5 | bd06f6b78154fe03036dce6733591b73 |
|
BLAKE2b-256 | 7aba443c392691af2df668f55042798205b5dede205e83b287321e4fe429486d |