-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add README with project description, features, installation, anβ¦
β¦d usage instructions for KillPy
- Loading branch information
Showing
1 changed file
with
65 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
```plaintext | ||
ββ βββ β β ββββ β β ____ | ||
ββββββ β β ββ βββ β .'`_ o `;__, | ||
ββββ β β β ββββ ββββ . .'.'` '---' ' | ||
ββ βββ β β ββ β β .`-...-'.' | ||
βββ `-...-' A tool to delete .venv directories | ||
``` | ||
|
||
<div align="center"> | ||
|
||
[](https://pepy.tech/project/KillPy) | ||
[](https://github.com/Tlaloc-Es/KillPy/stargazers) | ||
|
||
</div> | ||
|
||
# Delete .venv Directories | ||
|
||
`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. | ||
|
||
## Features | ||
|
||
- **Automatic search:** Finds all `.venv` directories recursively within a specified path. | ||
- **Safe deletion:** Lists the directories to be deleted and asks for confirmation. | ||
- **Fast and lightweight:** Minimal dependencies for quick execution. | ||
|
||
## Installation [](https://pypi.org/project/KillPy/) | ||
|
||
To install `killpy`, use pip: | ||
|
||
```bash | ||
pip install KillPy | ||
``` | ||
|
||
## Usage | ||
|
||
Run the following command to search and delete `.venv` directories: | ||
|
||
```bash | ||
killpy | ||
``` | ||
|
||
- Replace `<path>` with the directory where you want to search for `.venv` folders. | ||
- Example: | ||
|
||
```bash | ||
killpy ./my-projects | ||
``` | ||
|
||
## Contributing | ||
|
||
Contributions are welcome! If you'd like to improve this tool, feel free to fork the repository and submit a pull request. | ||
|
||
1. Fork the repository | ||
1. Create a new branch for your feature: `git checkout -b my-feature` | ||
1. Commit your changes: `git commit -m 'Add my feature'` | ||
1. Push to the branch: `git push origin my-feature` | ||
1. Submit a pull request | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. | ||
|
||
______________________________________________________________________ | ||
|
||
Thank you for using `KillPy`! If you find it useful, please star the repository on GitHub! |