Skip to content

Commit 17acbd4

Browse files
committed
docs: add README with project description, features, installation, and usage instructions for KillPy
1 parent f887d41 commit 17acbd4

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
```plaintext
2+
▗▖ ▗▖▄ █ █ ▗▄▄▖ ▄ ▄ ____
3+
▐▌▗▞▘▄ █ █ ▐▌ ▐▌█ █ .'`_ o `;__,
4+
▐▛▚▖ █ █ █ ▐▛▀▘ ▀▀▀█ . .'.'` '---' '
5+
▐▌ ▐▌█ █ █ ▐▌ ▄ █ .`-...-'.'
6+
▀▀▀ `-...-' A tool to delete .venv directories
7+
```
8+
9+
<div align="center">
10+
11+
[![Downloads](https://static.pepy.tech/personalized-badge/KillPy?period=month&units=international_system&left_color=grey&right_color=blue&left_text=PyPi%20Downloads)](https://pepy.tech/project/KillPy)
12+
[![Stars](https://img.shields.io/github/stars/Tlaloc-Es/KillPy?color=yellow&style=flat)](https://github.com/Tlaloc-Es/KillPy/stargazers)
13+
14+
</div>
15+
16+
# Delete .venv Directories
17+
18+
`KillPy` is a simple tool designed to locate and delete `.venv` directories from your projects. It can help you quickly clean up unnecessary virtual environments and save disk space.
19+
20+
## Features
21+
22+
- **Automatic search:** Finds all `.venv` directories recursively within a specified path.
23+
- **Safe deletion:** Lists the directories to be deleted and asks for confirmation.
24+
- **Fast and lightweight:** Minimal dependencies for quick execution.
25+
26+
## Installation [![PyPI](https://img.shields.io/pypi/v/KillPy.svg)](https://pypi.org/project/KillPy/)
27+
28+
To install `killpy`, use pip:
29+
30+
```bash
31+
pip install KillPy
32+
```
33+
34+
## Usage
35+
36+
Run the following command to search and delete `.venv` directories:
37+
38+
```bash
39+
killpy
40+
```
41+
42+
- Replace `<path>` with the directory where you want to search for `.venv` folders.
43+
- Example:
44+
45+
```bash
46+
killpy ./my-projects
47+
```
48+
49+
## Contributing
50+
51+
Contributions are welcome! If you'd like to improve this tool, feel free to fork the repository and submit a pull request.
52+
53+
1. Fork the repository
54+
1. Create a new branch for your feature: `git checkout -b my-feature`
55+
1. Commit your changes: `git commit -m 'Add my feature'`
56+
1. Push to the branch: `git push origin my-feature`
57+
1. Submit a pull request
58+
59+
## License
60+
61+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
62+
63+
______________________________________________________________________
64+
65+
Thank you for using `KillPy`! If you find it useful, please star the repository on GitHub!

0 commit comments

Comments
 (0)