Skip to content

Commit 7ae2e29

Browse files
felipeclarindofelipeclarindo
committed
feat(application): The stable version in the cli to manage the register of users.
1 parent fb1b9cd commit 7ae2e29

File tree

11 files changed

+2136
-2
lines changed

11 files changed

+2136
-2
lines changed

‎.gitignore‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# UV
98+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
#uv.lock
102+
103+
# poetry
104+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105+
# This is especially recommended for binary packages to ensure reproducibility, and is more
106+
# commonly ignored for libraries.
107+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108+
#poetry.lock
109+
110+
# pdm
111+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
112+
#pdm.lock
113+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
114+
# in version control.
115+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
116+
.pdm.toml
117+
.pdm-python
118+
.pdm-build/
119+
120+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
121+
__pypackages__/
122+
123+
# Celery stuff
124+
celerybeat-schedule
125+
celerybeat.pid
126+
127+
# SageMath parsed files
128+
*.sage.py
129+
130+
# Environments
131+
.env
132+
.venv
133+
env/
134+
venv/
135+
ENV/
136+
env.bak/
137+
venv.bak/
138+
139+
# Spyder project settings
140+
.spyderproject
141+
.spyproject
142+
143+
# Rope project settings
144+
.ropeproject
145+
146+
# mkdocs documentation
147+
/site
148+
149+
# mypy
150+
.mypy_cache/
151+
.dmypy.json
152+
dmypy.json
153+
154+
# Pyre type checker
155+
.pyre/
156+
157+
# pytype static type analyzer
158+
.pytype/
159+
160+
# Cython debug symbols
161+
cython_debug/
162+
163+
# PyCharm
164+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
165+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
166+
# and can be added to the global gitignore or merged into this file. For a more nuclear
167+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
168+
#.idea/
169+
170+
# Ruff stuff:
171+
.ruff_cache/
172+
173+
# PyPI configuration file
174+
.pypirc

‎README.md‎

Lines changed: 72 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,72 @@
1-
# users-register
2-
Projeto de cadastro de usuarios em python
1+
🌍 [Leia em Português](README.pt-BR.md)
2+
3+
# Users Register CLI
4+
5+
This program is a command line application for managing users. It allows you to register, update, show, search and delete users. The system also has a login menu for user authentication.
6+
7+
## Data Structure
8+
9+
The system uses a list of tuples to store users' data with the following fields: 1. login 2. login type 3. email 4. name 5. cpf 6. rg 7. date of birth 8. password 9. address 10. role (admin or user)
10+
11+
## Steps to perform
12+
13+
1. Clone the repository:
14+
15+
```bash
16+
git clone git clone https://github.com/felipeclarindo/users-register-cli.git
17+
```
18+
19+
2. Navigate to the project folder:
20+
21+
````bash
22+
cd user-register
23+
```bash
24+
cd user-register
25+
````
26+
27+
3. Run the program:
28+
29+
```bash
30+
python ./src/main.py
31+
```
32+
33+
## How to use
34+
35+
### 1. Authentication
36+
37+
The credentials to authenticate is:
38+
39+
- login: admin
40+
- passwrd: admin
41+
42+
### 2. When starting the program, you will see a main menu. Choose one of the options by typing the corresponding number and pressing Enter:
43+
44+
- 1 - Register user: Register a new user.
45+
- 2 - Update user: Updates the information of an existing user.
46+
- 3 - Show users: Displays the list of registered users.
47+
- 4 - Search user: Search a user based on specified criteria.
48+
- 5 - Delete user: Removes a user from the system.
49+
- 6 - Exit: Closes the program.
50+
51+
### 3. In the login menu, you can choose the authentication method:
52+
53+
- 1 - Email
54+
- 2 - User
55+
- 3 - CPF
56+
- 4 - RG
57+
58+
## Contribution
59+
60+
Contributions are welcome! If you have suggestions for improvements, feel free to open an issue or submit a pull request.
61+
62+
## Author
63+
64+
**Felipe Clarindo**
65+
66+
- [LinkedIn](https://www.linkedin.com/in/felipeclarindo)
67+
- [Instagram](https://www.instagram.com/lipethecoder)
68+
- [GitHub](https://github.com/felipeclarindo)
69+
70+
## License
71+
72+
This project is licensed under the [GNU Affero License](https://www.gnu.org/licenses/agpl-3.0.html).

‎README.pt-BR.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
🌍 [Read in English](README.md)
2+
3+
# Users Register CLI
4+
5+
Este programa é uma aplicação de linha de comando para gerenciar usuários. Ele permite cadastrar, atualizar, mostrar, pesquisar e deletar usuários. O sistema também possui um menu de login para autenticação dos usuários.
6+
7+
## Estrutura de Dados
8+
9+
O sistema usa uma lista de tuplas para armazenar os dados dos usuários com os seguintes campos: 1. login 2. tipo-login 3. email 4. nome 5. cpf 6. rg 7. data-nascimento 8. senha 9. endereco 10. role (admin ou user)
10+
11+
## Passos para execução
12+
13+
1. Clone o repositório do Projeto para sua máquina:
14+
15+
```bash
16+
git clone https://github.com/felipeclarindo/users-register-cli.git
17+
```
18+
19+
2. Navegue até a pasta do projeto:
20+
21+
```bash
22+
cd user-register
23+
```
24+
25+
3. Execute o programa:
26+
27+
```bash
28+
python src/main.py
29+
```
30+
31+
## Como usar
32+
33+
### 1. Autenticação
34+
35+
As credenciais para autenticação são:
36+
37+
- login: admin
38+
- passwrd: admin
39+
40+
### 2. Ao iniciar o programa, você verá um menu principal. Escolha uma das opções digitando o número correspondente e pressionando Enter:
41+
42+
- 1 - Cadastrar usuário: Cadastra um novo usuário.
43+
- 2 - Atualizar usuário: Atualiza as informações de um usuário existente.
44+
- 3 - Mostrar usuários: Exibe a lista de usuários cadastrados.
45+
- 4 - Pesquisar usuário: Pesquisa um usuário com base em critérios especificados.
46+
- 5 - Deletar usuário: Remove um usuário do sistema.
47+
- 6 - Sair: Encerra o programa.
48+
49+
### 3. No menu de login, você pode escolher o método de autenticação:
50+
51+
- 1 - Email
52+
- 2 - Usuário
53+
- 3 - CPF
54+
- 4 - RG
55+
56+
## Contribuições
57+
58+
Contribuições são bem-vindas! Se você encontrar algum problema ou tiver sugestões de melhorias, sinta-se à vontade para abrir uma issue ou enviar um pull request.
59+
60+
## Autor
61+
62+
Desenvolvido por **Felipe Clarindo**.
63+
64+
- [LinkedIn](https://www.linkedin.com/in/felipeclarindo/)
65+
- [Instagram](https://www.instagram.com/lipethegoat)
66+
- [GitHub](https://github.com/felipeclarindo)
67+
68+
## Licença
69+
70+
Este projeto está licenciado sob a [GNU Affero License](https://www.gnu.org/licenses/agpl-3.0.html).

‎src/__init__.py‎

Whitespace-only changes.

0 commit comments

Comments
 (0)