Skip to content

Commit 887cdf6

Browse files
authored
Update README.md
1 parent 3a0b9ef commit 887cdf6

1 file changed

Lines changed: 77 additions & 35 deletions

File tree

README.md

Lines changed: 77 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,105 @@
1-
⭐ Leave a Star ⭐
2-
<p align="center">
3-
<img src="https://img.shields.io/github/stars/SwezyDev/secure_input.svg?style=for-the-badge"/>
1+
![standard (3)](https://github.com/SwezyDev/secure_input/assets/109398018/72249ff7-eb81-4dbf-b9d9-accf1b359e65)
42

5-
<img src="https://img.shields.io/github/issues/SwezyDev/secure_input.svg?style=for-the-badge"/>
3+
<p align="center">
4+
<a href="https://pypi.org/project/secure-input/"><img src="https://img.shields.io/badge/PyPI-secure--input-orange?style=for-the-badge&logo=pypi" alt="PyPI"></a>
5+
<a href="https://www.python.org" target="_blank"><img src="https://img.shields.io/badge/Language-Python-3776AB?style=for-the-badge&logo=python" alt="Python"></a>
6+
<a href="https://t.me/swezy" target="_blank"><img src="https://img.shields.io/badge/Telegram-@Swezy-blue?style=for-the-badge&logo=telegram" alt="Telegram"/></a>
7+
<br>
8+
<a href="https://pypi.org/project/secure-input/"><img src="https://img.shields.io/badge/Version-1.0.3-green?style=for-the-badge&logo=pypi" alt="PyPI"></a>
9+
<br>
10+
<code>Leave a ⭐ if you like this repository</code>
11+
</p>
612

7-
<img src="https://img.shields.io/github/license/SwezyDev/secure_input.svg?style=for-the-badge"/>
13+
---
814

9-
<img src="https://img.shields.io/github/forks/SwezyDev/secure_input.svg?style=for-the-badge"/>
15+
## 🚩 What is `secure_input`?
1016

11-
<img src="https://img.shields.io/github/contributors/SwezyDev/secure_input.svg?style=for-the-badge"/>
17+
`secure_input` is a tiny, dependency-free Python package that provides a secure, user-friendly way to prompt for sensitive input (like passwords) in terminal applications. It supports masking (e.g. `*`) and aims to be simple to use and easy to drop into any script.
1218

13-
</p>
14-
<p align="center">
15-
<p align='center'><a href="https://awesome.re"><img src="https://awesome.re/badge.svg" ></p></a>
16-
</p>
17-
18-
__Current Version__ : 1.0.3
19-
![standard (3)](https://github.com/SwezyDev/secure_input/assets/109398018/72249ff7-eb81-4dbf-b9d9-accf1b359e65)
20-
- [Discord](https://discord.gg/KkxjCe8Fg2)
21-
- [PyPI](https://pypi.org/project/secure-input/)
19+
---
2220

23-
---------------------------------------
21+
## 🚀 Installation
2422

25-
Install : ```pip install secure-input```
23+
Install from PyPI:
2624

27-
PyPI : https://pypi.org/project/secure-input/
25+
```bash
26+
pip install secure-input
27+
```
2828

29-
---------------------------------------
29+
PyPI: [https://pypi.org/project/secure-input/](https://pypi.org/project/secure-input/)
3030

31-
__How to use__ :
31+
---
3232

33-
**Python Example** :
33+
## 🧩 Quick usage
3434

35-
---------------------------------------
3635
```py
3736
from secure_input import secure_input
3837

3938
password = secure_input("Enter your Password: ", show="*")
39+
print("You entered:", password)
40+
```
41+
42+
`secure_input(prompt: str, show: str) -> str`
43+
44+
* `prompt`: text shown to the user
45+
* `show`: masking character (e.g. `"*"`)
46+
47+
---
48+
49+
## 📚 Features
50+
51+
* Easy Usage
52+
* Optional masking character for input
53+
* Cross-platform terminals supported
54+
55+
---
4056

41-
print(password)
57+
## ⚠️ Notes & Limitations
58+
59+
* Non-ASCII characters (e.g. `Ö Ä Ü ß`) may **not** be handled correctly — use plain ASCII letters, numbers and symbols for best results.
60+
* Always validate and handle the secret data securely in your application (do not print or log real passwords in production).
61+
62+
---
63+
64+
## 🧪 Examples
65+
66+
A short interactive example:
67+
68+
```py
69+
from secure_input import secure_input
70+
71+
api_key = secure_input("API Key: ", show="*")
72+
if len(api_key) == 0:
73+
print("No key provided")
74+
else:
75+
print("Key received (length):", len(api_key))
4276
```
43-
<p align="center">
44-
<a href="https://github.com/alwinw?tab=repositories&language=python" target="_blank"><img alt="python" src="https://img.shields.io/badge/-python-3776AB?style=flat-square&logo=Python&logoColor=white"></a>
45-
</p>
4677

47-
---------------------------------------
78+
---
79+
80+
## 📦 Where to get help
81+
82+
* Project on PyPI: [pypi.org/project/secure-input/](https://pypi.org/project/secure-input/)
83+
* Telegram: [@Swezy](https://t.me/Swezy)
84+
85+
---
4886

49-
__Notes__ : Ö Ä Ü ß Doesn't work only normal ASCII Letters, Numbers and Symbols
87+
## 📝 License
5088

51-
---------------------------------------
89+
Distributed under the **MIT License** — see `LICENSE` for details.
5290

53-
![image](https://github.com/SwezyDev/secure_input/assets/109398018/ee99a27d-21b0-4b73-a88c-c97811d43b3d)
91+
---
5492

55-
---------------------------------------
93+
## 👤 Maintainer & Contact
5694

57-
- Swezy <3
95+
* Maintainer: **Swezy**[https://github.com/SwezyDev](https://github.com/SwezyDev)
96+
* Telegram: [@Swezy](https://t.me/Swezy)
5897

59-
---------------------------------------
98+
---
99+
100+
<p align="center">
101+
<sub>Made with ❤️ — If you find this useful, please leave a ⭐ on the repo</sub>
102+
</p>
60103

61104
<a href="https://star-history.com/#SwezyDev/secure_input&Date">
62105
<picture>
@@ -65,4 +108,3 @@ __Notes__ : Ö Ä Ü ß Doesn't work only normal ASCII Letters, Numbers and Symb
65108
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=SwezyDev/secure_input&type=Date" />
66109
</picture>
67110
</a>
68-

0 commit comments

Comments
 (0)