|
1 | 1 | # Python Password |
2 | 2 |
|
| 3 | +<<<<<<< HEAD |
3 | 4 |  |
4 | 5 |
|
5 | 6 | **Hello world!** This is my first project of usable program. |
| 7 | +======= |
| 8 | +**Hello world!** This is my very first project of usable program. |
| 9 | +>>>>>>> dev |
6 | 10 |
|
7 | | -*For now it's named as above, because I have no better idea how to name it. Here are some words about it.* |
| 11 | +### What is the program about? |
8 | 12 |
|
9 | | -## What is the program about? |
10 | 13 | Python Password is intended to safely store passwords. |
11 | 14 |
|
12 | | -## How does it work? |
13 | | -Program is saving passwords to local database (SQLite database). Passwords are encrypted with a secret key, based |
14 | | -on master password and salt, both could be a user input (or only the first one) so you can re-create the file |
15 | | -when it's gone for some reasons. When you would like to get any password it won't be prompted on the screen, but |
16 | | -safely copied to clipboard. |
17 | | - |
18 | | -## Quick start guide for `v0.1.x` |
19 | | -1. At very first launch, program will create 3 files: |
20 | | - |
21 | | - - `Alpha.key`, |
22 | | - - `Beta.key`, |
23 | | - - `Passwords.db`. |
24 | | - |
25 | | - All of them are needed for proper program functioning. Each subsequent start of the program is trying to find those |
26 | | - files. Every missing file will be re-created. |
27 | | - |
28 | | -2. After program will check files, you will se typical console GUI. You can provide option number, or underlined letter. |
29 | | - Options are: |
30 | | - |
31 | | - 1. **Change alpha password** - if you want to change your master password. |
32 | | - 2. **Get password** - program shows all saved passwords' names and asks which you want to get. Password isn't |
33 | | - prompted, it's being copied to clipboard. (Same as <kbd>Ctrl + C</kbd>, <kbd>Ctrl + V</kbd>) |
34 | | - 3. **Set password** - used for saving password. |
35 | | - 4. **Delete password** - after double inserting password's name, that password is being deleted from local database. |
36 | | - 5. **Info** - useful links and info about the program. |
37 | | - 6. **Exit** - I think I don't have to describe it. |
38 | | - |
39 | | -3. Program is working in loop, so it will continue working unless you will close the window or select `Exit` option. |
| 15 | +### How does it work? |
| 16 | + |
| 17 | +Program is saving passwords to local database (SQLite database). Passwords are encrypted with a secret key, based on |
| 18 | +master password and salt, both could be a user input or random values, so you can re-create the file when it's gone for |
| 19 | +some reasons. When you would like to get any password it won't be prompted on the screen, but safely copied to |
| 20 | +clipboard. |
| 21 | + |
| 22 | +## Quick start guide |
| 23 | + |
| 24 | + |
| 25 | +### Passwords menu |
| 26 | + |
| 27 | +Maim screen of program is passwords menu. From here you can: |
| 28 | + |
| 29 | +- add passwords, |
| 30 | +- copy passwords, |
| 31 | +- delete passwords. |
| 32 | + |
| 33 | +On the left side there will be displayed list of saved passwords. Ypu can click on specific password to see context |
| 34 | +menu wth 3 options; "copy", "delete" and "nothing". |
| 35 | + |
| 36 | +On the right side there are 4 sections. |
| 37 | + |
| 38 | +1. **Adding password.** To add password, simply enter it's alias and password itself. Then click button to add it. |
| 39 | +2. **Removing password.** You can delete password also from here. Simply provide it's alias and click button. |
| 40 | +3. **Info.** - Here you can see how many passwords there are in database. |
| 41 | +4. **Refresh.** - Click this button to refresh view, and fetch passwords from local database. |
| 42 | + |
| 43 | + |
| 44 | +### Settings menu |
| 45 | + |
| 46 | +In this menu, you can: |
| 47 | + |
| 48 | +- change alpha password, |
| 49 | +- change beta password. |
| 50 | + |
| 51 | +You can see in `FAQ.md` how do they work. |
| 52 | + |
| 53 | +There will be also options to manage backups. |
| 54 | + |
| 55 | + |
| 56 | +### Info menu |
| 57 | + |
| 58 | +On the left side, there are some basic information about version, author and 3rd party software. |
| 59 | + |
| 60 | +On the right side you can see (of course clickable) links. |
| 61 | + |
40 | 62 |
|
41 | 63 | ## How to start using? |
| 64 | + |
42 | 65 | For download please look at [releases section](https://github.com/AnonymousX86/Python-Password/releases). |
43 | 66 |
|
44 | | -If you want to help me improve this program, (report issues etc.) please contact me via Discord: `Anonymous©#7296`, |
45 | | -or use [GitHub issues](https://github.com/AnonymousX86/Python-Password/issues). |
| 67 | +--- |
46 | 68 |
|
47 | | -### Thanks for all of your help! |
| 69 | +*If you want to help me improve this program, (report issues etc.) or just talk, please contact me via |
| 70 | +Discord: `Anonymous©#7296`, or use [GitHub issues](https://github.com/AnonymousX86/Python-Password/issues).* |
0 commit comments