password-manager

password-manager

A simple python password manager to help your life.
Explore the docs »

Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Authors

About the Project

password-manager is a simple Python password manager. It allows you to securely save secrets with a simple CLI interface.

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Python 3.7 or greater

apt-get install python3

Installation

1. Clone the repo

git clone https://github.com/rodrigodalri/password-manager.git

2. Create venv

python3 -m venv .
source bin/activate

3. Install pip requirements

pip3 install -r requirements.txt

4. Build

python3 -m build

Usage

To start your password manager runs:

python3 src/manager.py

If it is your first access, enter your name and master password and write down your 24 mnemonical words in a safe and offline place.

$ python3 src/manager.py 
Please enter your name: TestUser
Please chose your master password: senha
Save the 24 words in offline world:
pencil invest kid frost excuse glory people adult squeeze deny swallow cloud nominee wave athlete pupil legend domain wisdom jungle matrix fat soul ketchup

Your identity has been saved!
Congratulations!
Your safe has been created!
What would you like to store in it today?

If not, just enter your master password to access the database.

$ python3 src/manager.py 
Please enter the master password: senha
Welcome Back sir TestUser!

You now have access to the usage options. The steps are self-explanatory. Enjoy

--------------------------------------------
Commands:
Press 1 : to recover your master password
Press 2 : to save a new password
Press 3 : to get a stored password
Press 4 : to list all stored services
Press 5 : to quit
--------------------------------------------
Enter: 

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature/Fix Branch (git checkout -b feature/AmazingFeature) or (git checkout -b fix/AmazingFix)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

Contributors	Contributions
Rodrigo Dal Ri	Contributions by rodrigodalri

See also the full list of contributors who participated in this project.