Skip to content

Commit

Permalink
docs: add README with project description, features, installation, an…
Browse files Browse the repository at this point in the history
…d usage instructions for KillPy
  • Loading branch information
Tlaloc-Es committed Jan 2, 2025
1 parent f887d41 commit 17acbd4
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions README.md
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">

[![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)
[![Stars](https://img.shields.io/github/stars/Tlaloc-Es/KillPy?color=yellow&style=flat)](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 [![PyPI](https://img.shields.io/pypi/v/KillPy.svg)](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!

0 comments on commit 17acbd4

Please sign in to comment.