Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/davidsantana06/account-keeper

Command-line application (CLI) designed for efficient and organized management of digital accounts.
https://github.com/davidsantana06/account-keeper

password-generator python sqlite typer

Last synced: 16 days ago
JSON representation

Command-line application (CLI) designed for efficient and organized management of digital accounts.

Host: GitHub
URL: https://github.com/davidsantana06/account-keeper
Owner: davidsantana06
License: mit
Created: 2024-10-17T01:01:19.000Z (about 1 month ago)
Default Branch: main
Last Pushed: 2024-10-23T22:00:23.000Z (25 days ago)
Last Synced: 2024-10-24T07:18:30.882Z (24 days ago)
Topics: password-generator, python, sqlite, typer
Language: Python
Homepage:
Size: 6.84 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ### 🔐 Account Keeper

Command-line application (CLI) designed for efficient and organized management of digital accounts. The database is fully portable, allowing access to data from anywhere without the need for an internet connection.

![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)

![Typer](https://img.shields.io/badge/Typer-000000?style=for-the-badge)

![SQLite](https://img.shields.io/badge/sqlite-%2307405e.svg?style=for-the-badge&logo=sqlite&logoColor=white)

### 🛠️ Installation

The system was developed using **Python 3.12**, and it is recommended to use this version for compatibility.

To obtain a local copy of the source code, run the following command:

```bash

git clone https://github.com/davidsantana06/account-keeper

```

Next, install the application dependencies with:

```bash

pip install -r requirements.txt

```

### 🤖 Commands

#### ![Create Account](https://img.shields.io/badge/C-Create_Account-28a745?style=for-the-badge)

```bash

python -m app account create    

```

| **Field** | **Parameter** | **Type** | **Required** |

| --------- | ------------- | -------- | ------------ |

| Name      | `name`        | `string` | 👍           |

| Username  | `username`    | `string` | 👎           |

| E-mail    | `email`       | `string` | 👎           |

| Phone     | `phone`       | `string` | 👎           |

#

#### ![Retrieve All Accounts](https://img.shields.io/badge/R-Retrieve_All_Accounts-007bff?style=for-the-badge)

```bash

python -m app account all

```

#

#### ![Retrieve All Accounts By Name](https://img.shields.io/badge/R-Retrieve_All_Accounts_By_Name-007bff?style=for-the-badge)

```bash

python -m app account all --name 

```

| **Field** | **Parameter** | **Type** | **Required** |

| --------- | ------------- | -------- | ------------ |

| Name      | `name`        | `string` | 👍           |

#

#### ![Retrieve One Account By ID](https://img.shields.io/badge/R-Retrieve_One_Account_By_ID-007bff?style=for-the-badge)

```bash

python -m app account one --id 

```

| **Field** | **Parameter** | **Type** | **Required** |

| --------- | ------------- | -------- | ------------ |

| ID        | `id`          | `string` | 👍           |

#

#### ![Retrieve One Account By ID](https://img.shields.io/badge/R-Retrieve_One_Account_By_Name-007bff?style=for-the-badge)

```bash

python -m app account one --name 

```

| **Field** | **Parameter** | **Type** | **Required** |

| --------- | ------------- | -------- | ------------ |

| Name      | `name`        | `string` | 👍           |

#

#### ![Update Account Name](https://img.shields.io/badge/U-Update_Account_Name-ffc107?style=for-the-badge)

```bash

python -m app account update  --name 

```

| **Field** | **Parameter** | **Type** | **Required** |

| --------- | ------------- | -------- | ------------ |

| ID        | `id`          | `string` | 👍           |

| Name      | `name`        | `string` | 👍           |

#

#### ![Update Account Password](https://img.shields.io/badge/U-Update_Account_Password-ffc107?style=for-the-badge)

```bash

python -m app account update  --password

```

| **Field** | **Parameter** | **Type** | **Required** |

| --------- | ------------- | -------- | ------------ |

| ID        | `id`          | `string` | 👍           |

| Password  | `password`    | `string` | 👍           |

#

#### ![Delete Account](https://img.shields.io/badge/D-Delete_Account-dc3545?style=for-the-badge)

```bash

python -m app account delete 

```

| **Field** | **Parameter** | **Type** | **Required** |

| --------- | ------------- | -------- | ------------ |

| ID        | `id`          | `string` | 👍           |

### ⚖️ License

This project adopts the **MIT License**, which allows you to use and make modifications to the code as you wish. The only thing I ask is that proper credit is given, acknowledging the effort and time I invested in building it.