| Name | venvwatch JSON |
| Version |
0.6
JSON |
| download |
| home_page | None |
| Summary | Automatically updates requirements.txt by watching your virtual environment for changes |
| upload_time | 2024-08-12 17:20:38 |
| maintainer | None |
| docs_url | None |
| author | Casual Engineer Zombie |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# VenvWatch
VenvWatch is a lightweight Python package that continuously monitors your virtual environment and automatically updates your `requirements.txt` file whenever you install or uninstall a package. No more manually managing dependencies—VenvWatch does it for you in real-time!
## Features
- **Automatic Sync**: Detects changes in your virtual environment and updates `requirements.txt` instantly.
- **Continuous Monitoring**: Runs in the background, listening for any modifications to your installed packages.
- **Simple CLI**: Easy-to-use command-line interface to start and manage the watcher.
- **Configurable Options**: Customize how VenvWatch handles changes, such as removing unused dependencies.
## Installation
Install VenvWatch using pip:
```bash
pip install venvwatch
```
## Usage
### Basic Usage
To start monitoring your virtual environment, navigate to your project directory and run:
```bash
venvwatch watch
```
VenvWatch will monitor your virtual environment for any changes and update the `requirements.txt` file accordingly.
### Configuration Options
VenvWatch can be customized with a variety of command-line options:
- **`--venv`**: Specify the path to your virtual environment.
```bash
venvwatch watch --venv /path/to/your/venv
```
- **`--interval`**: Set the interval (in seconds) for how often VenvWatch checks for changes.
```bash
venvwatch watch --interval 5
```
- **`--no-remove`**: Disable automatic removal of dependencies that are no longer in the environment.
```bash
venvwatch watch --no-remove
```
### Example
Start watching your virtual environment and update `requirements.txt` in real-time:
```bash
venvwatch watch --venv ./venv --interval 5
```
VenvWatch will run in the background, keeping your `requirements.txt` file perfectly synced with your installed packages.
## Contributing
Contributions are welcome! If you have any ideas, suggestions, or find any bugs, feel free to open an issue or submit a pull request.
1. Fork the repository.
2. Create a new branch.
3. Make your changes.
4. Submit a pull request.
## License
VenvWatch is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Support
If you encounter any issues or have questions, please open an issue on [GitHub](https://github.com/yourusername/VenvWatch/issues).
---
**Happy Coding!**
Raw data
{
"_id": null,
"home_page": null,
"name": "venvwatch",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Casual Engineer Zombie",
"author_email": "py@casualzom.dev",
"download_url": "https://files.pythonhosted.org/packages/ba/30/0e0bae8abcc0137d789f7cbb69099fd795e0ffab89454de471d2ddcef384/venvwatch-0.6.tar.gz",
"platform": null,
"description": "# VenvWatch\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nVenvWatch is a lightweight Python package that continuously monitors your virtual environment and automatically updates your `requirements.txt` file whenever you install or uninstall a package. No more manually managing dependencies\u00e2\u20ac\u201dVenvWatch does it for you in real-time!\r\n\r\n\r\n## Features\r\n\r\n- **Automatic Sync**: Detects changes in your virtual environment and updates `requirements.txt` instantly.\r\n- **Continuous Monitoring**: Runs in the background, listening for any modifications to your installed packages.\r\n- **Simple CLI**: Easy-to-use command-line interface to start and manage the watcher.\r\n- **Configurable Options**: Customize how VenvWatch handles changes, such as removing unused dependencies.\r\n\r\n## Installation\r\n\r\nInstall VenvWatch using pip:\r\n\r\n```bash\r\npip install venvwatch\r\n```\r\n\r\n## Usage\r\n\r\n### Basic Usage\r\n\r\nTo start monitoring your virtual environment, navigate to your project directory and run:\r\n\r\n```bash\r\nvenvwatch watch\r\n```\r\n\r\nVenvWatch will monitor your virtual environment for any changes and update the `requirements.txt` file accordingly.\r\n\r\n### Configuration Options\r\n\r\nVenvWatch can be customized with a variety of command-line options:\r\n\r\n- **`--venv`**: Specify the path to your virtual environment.\r\n ```bash\r\n venvwatch watch --venv /path/to/your/venv\r\n ```\r\n\r\n- **`--interval`**: Set the interval (in seconds) for how often VenvWatch checks for changes.\r\n ```bash\r\n venvwatch watch --interval 5\r\n ```\r\n\r\n- **`--no-remove`**: Disable automatic removal of dependencies that are no longer in the environment.\r\n ```bash\r\n venvwatch watch --no-remove\r\n ```\r\n\r\n### Example\r\n\r\nStart watching your virtual environment and update `requirements.txt` in real-time:\r\n\r\n```bash\r\nvenvwatch watch --venv ./venv --interval 5\r\n```\r\n\r\nVenvWatch will run in the background, keeping your `requirements.txt` file perfectly synced with your installed packages.\r\n\r\n## Contributing\r\n\r\nContributions are welcome! If you have any ideas, suggestions, or find any bugs, feel free to open an issue or submit a pull request.\r\n\r\n1. Fork the repository.\r\n2. Create a new branch.\r\n3. Make your changes.\r\n4. Submit a pull request.\r\n\r\n## License\r\n\r\nVenvWatch is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\r\n\r\n## Support\r\n\r\nIf you encounter any issues or have questions, please open an issue on [GitHub](https://github.com/yourusername/VenvWatch/issues).\r\n\r\n---\r\n\r\n**Happy Coding!**\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Automatically updates requirements.txt by watching your virtual environment for changes",
"version": "0.6",
"project_urls": {
"Source": "https://github.com/CasualEngineerZombie/venvwatch",
"Tracker": "https://github.com/CasualEngineerZombie/venvwatch/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "821168a31773d277e6862a7a33309db293cd6b7cac31e645bdeef90485fa6ab8",
"md5": "0e674aa040f9418644d7d2b15806b217",
"sha256": "6be435b79549bdb814d5dab61b7bd406bd7c4e1c582e95a8ebc05ce981f02a9e"
},
"downloads": -1,
"filename": "venvwatch-0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e674aa040f9418644d7d2b15806b217",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5765,
"upload_time": "2024-08-12T17:20:36",
"upload_time_iso_8601": "2024-08-12T17:20:36.800587Z",
"url": "https://files.pythonhosted.org/packages/82/11/68a31773d277e6862a7a33309db293cd6b7cac31e645bdeef90485fa6ab8/venvwatch-0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba300e0bae8abcc0137d789f7cbb69099fd795e0ffab89454de471d2ddcef384",
"md5": "8f8d81bd38cb95811a50ab40ef7751bd",
"sha256": "fc1836831752438b3fdddbe5799067263fa244884b6cd8ed7b1944fbe0bec73d"
},
"downloads": -1,
"filename": "venvwatch-0.6.tar.gz",
"has_sig": false,
"md5_digest": "8f8d81bd38cb95811a50ab40ef7751bd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4353,
"upload_time": "2024-08-12T17:20:38",
"upload_time_iso_8601": "2024-08-12T17:20:38.639402Z",
"url": "https://files.pythonhosted.org/packages/ba/30/0e0bae8abcc0137d789f7cbb69099fd795e0ffab89454de471d2ddcef384/venvwatch-0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-12 17:20:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CasualEngineerZombie",
"github_project": "venvwatch",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "venvwatch"
}
