# Simple Password Manager
[](https://badge.fury.io/py/simple-password-manager)
[](https://opensource.org/licenses/MIT)
## Overview
Simple Password Manager is a lightweight and secure Python package for managing passwords. It allows users to store, retrieve, and manage their passwords securely using encryption with a single master password. It supports two types of storage: local storage and cloud storage. The package provides a command-line interface (CLI) for easy management of passwords.
## Features
- **Encryption:** All passwords are encrypted using a master password.
- **Secure Storage:** Passwords are stored in a secure format locally or in the cloud.
- **Command-Line Interface:** Easy to use CLI for managing passwords.
- **Custom Password Generation:** Generate secure passwords on the fly.
- **Log and Backup System:** Keeps track of changes and allows for easy backup.
## Installation
Install the package using pip:
```bash
pip install simple-password-manager
```
## Usage
### Command-Line Interface (CLI)
The Simple Password Manager can be used directly from the command line with the following commands:
1. **Start in Online or Offline Mode:**
- For online use, where your passwords are stored securely in the cloud:
```bash
spm mode -o
```
- For offline use, where your passwords are stored locally:
```bash
spm mode -f
```
2. **Create an Account:**
- Once the mode is selected, sign up by creating an account:
```bash
spm signup <username>
```
3. **Manage Your Passwords:**
- After creating an account, you can begin managing your passwords with the following commands:
- **Add a new password:**
```bash
spm add <service> <username>
```
- **Retrieve a password:**
```bash
spm get <service>
```
- **Update an existing password:**
```bash
spm update <service>
```
- **Delete a password:**
```bash
spm delete <service>
```
### Python Integration
You can also use Simple Password Manager directly in your Python code:
```python
from simplepasswordmanager import Manager, OfflineManager, OnlineManager
# Initialize the manager
manager = Manager(master_password="your_master_password")
# Example usage:
manager.add_password("gmail", "your_email@gmail.com", "your_password")
password = manager.get_password("gmail")
print(f"Retrieved password: {password}")
```
## Notes
- If you have your own solution to store your passwords on the cloud, you can modify where the package stores your passwords online by updating the settings in setting.py.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/7alle9/Simple-Password-Manager",
"name": "simple-password-manager",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, password, manager, simple, cli, security",
"author": "Amir Mallek",
"author_email": "mallekamir123@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/74/64/0c8f125dcc5c01ee6cf70cb0adee8514806db2065dc84599b73670856620/simple-password-manager-0.0.4.tar.gz",
"platform": null,
"description": "# Simple Password Manager\r\n[](https://badge.fury.io/py/simple-password-manager)\r\n[](https://opensource.org/licenses/MIT)\r\n\r\n\r\n## Overview\r\nSimple Password Manager is a lightweight and secure Python package for managing passwords. It allows users to store, retrieve, and manage their passwords securely using encryption with a single master password. It supports two types of storage: local storage and cloud storage. The package provides a command-line interface (CLI) for easy management of passwords.\r\n\r\n## Features\r\n- **Encryption:** All passwords are encrypted using a master password.\r\n- **Secure Storage:** Passwords are stored in a secure format locally or in the cloud.\r\n- **Command-Line Interface:** Easy to use CLI for managing passwords.\r\n- **Custom Password Generation:** Generate secure passwords on the fly.\r\n- **Log and Backup System:** Keeps track of changes and allows for easy backup.\r\n\r\n## Installation\r\nInstall the package using pip:\r\n\r\n```bash\r\npip install simple-password-manager\r\n```\r\n\r\n## Usage\r\n\r\n### Command-Line Interface (CLI)\r\nThe Simple Password Manager can be used directly from the command line with the following commands:\r\n\r\n1. **Start in Online or Offline Mode:**\r\n - For online use, where your passwords are stored securely in the cloud:\r\n ```bash\r\n spm mode -o\r\n ```\r\n - For offline use, where your passwords are stored locally:\r\n ```bash\r\n spm mode -f\r\n ```\r\n\r\n2. **Create an Account:**\r\n - Once the mode is selected, sign up by creating an account:\r\n ```bash\r\n spm signup <username>\r\n ```\r\n\r\n3. **Manage Your Passwords:**\r\n - After creating an account, you can begin managing your passwords with the following commands:\r\n - **Add a new password:**\r\n ```bash\r\n spm add <service> <username>\r\n ```\r\n - **Retrieve a password:**\r\n ```bash\r\n spm get <service>\r\n ```\r\n - **Update an existing password:**\r\n ```bash\r\n spm update <service>\r\n ```\r\n - **Delete a password:**\r\n ```bash\r\n spm delete <service>\r\n ```\r\n\r\n### Python Integration\r\nYou can also use Simple Password Manager directly in your Python code:\r\n\r\n```python\r\nfrom simplepasswordmanager import Manager, OfflineManager, OnlineManager\r\n\r\n# Initialize the manager\r\nmanager = Manager(master_password=\"your_master_password\")\r\n\r\n# Example usage:\r\nmanager.add_password(\"gmail\", \"your_email@gmail.com\", \"your_password\")\r\npassword = manager.get_password(\"gmail\")\r\nprint(f\"Retrieved password: {password}\")\r\n```\r\n\r\n## Notes\r\n- If you have your own solution to store your passwords on the cloud, you can modify where the package stores your passwords online by updating the settings in setting.py.\r\n\r\n## License\r\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple password manager",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/7alle9/Simple-Password-Manager"
},
"split_keywords": [
"python",
" password",
" manager",
" simple",
" cli",
" security"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23d1b7c0dbb570cbb53d628b8f531c3f95d667808ef7fb1202634330756378e2",
"md5": "7b3fc1822b8a86d21d3e2a23b714b367",
"sha256": "9c94faca7522dfde759f667b65a1f3d25afd2dc46c1066a4f314af55ea15580d"
},
"downloads": -1,
"filename": "simple_password_manager-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7b3fc1822b8a86d21d3e2a23b714b367",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12633,
"upload_time": "2024-08-14T12:27:06",
"upload_time_iso_8601": "2024-08-14T12:27:06.254477Z",
"url": "https://files.pythonhosted.org/packages/23/d1/b7c0dbb570cbb53d628b8f531c3f95d667808ef7fb1202634330756378e2/simple_password_manager-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "74640c8f125dcc5c01ee6cf70cb0adee8514806db2065dc84599b73670856620",
"md5": "c3c22ba7b67e7f9e5bb4bb83fcfc3c1c",
"sha256": "73c6725382cd1ae68a15db8a51b71f26d70c5a875497c0223fe0aad0164ea8a2"
},
"downloads": -1,
"filename": "simple-password-manager-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "c3c22ba7b67e7f9e5bb4bb83fcfc3c1c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9961,
"upload_time": "2024-08-14T12:27:08",
"upload_time_iso_8601": "2024-08-14T12:27:08.107491Z",
"url": "https://files.pythonhosted.org/packages/74/64/0c8f125dcc5c01ee6cf70cb0adee8514806db2065dc84599b73670856620/simple-password-manager-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 12:27:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "7alle9",
"github_project": "Simple-Password-Manager",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "simple-password-manager"
}
JSON
