| Name | stouch JSON |
| Version |
0.1.0.post1
JSON |
| download |
| home_page | https://github.com/azataiot/stouch |
| Summary | An extensible touch command with plugin support, allowing for enhanced file creation capabilities. |
| upload_time | 2023-09-07 09:29:07 |
| maintainer | |
| docs_url | None |
| author | Azat |
| requires_python | >=3.11,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# stouch
An extensible touch command with plugin support, allowing for enhanced file creation capabilities.
## Description
`stouch` is a modern take on the classic `touch` command, designed to be extensible with plugins. Whether you want to slugify filenames, add timestamps, or any other custom behavior, `stouch` has got you covered.
## Features
- **Extensible**: Easily add new functionalities with plugins.
- **Built-in Plugins**: Comes with a slugify plugin out of the box.
- **Easy to Use**: Simple CLI interface powered by Typer.
## Installation
Using poetry:
```bash
poetry install stouch
```
To install with the slugify plugin:
```bash
poetry install stouch[slugify]
```
## Usage
Basic usage:
```bash
stouch filename.txt
```
Using the slugify plugin:
```bash
stouch "My New File.txt" --plugin=slugify
```
## Developing Plugins
Check out our [plugin development guide](LINK_TO_PLUGIN_GUIDE) to learn how to create your own plugins for `stouch`.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! Please read our [contributing guidelines](LINK_TO_CONTRIBUTING_GUIDE) to get started.
## Acknowledgements
- [Typer](https://typer.tiangolo.com/) for the CLI framework.
- [python-slugify](https://pypi.org/project/python-slugify/) for the slugification utility.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/azataiot/stouch",
"name": "stouch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Azat",
"author_email": "8280770+azataiot@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/47/0e/98e994687dc8668bee815cba30751920541cf19650fac4697bcd7d43b7a0/stouch-0.1.0.post1.tar.gz",
"platform": null,
"description": "# stouch\n\nAn extensible touch command with plugin support, allowing for enhanced file creation capabilities.\n\n## Description\n\n`stouch` is a modern take on the classic `touch` command, designed to be extensible with plugins. Whether you want to slugify filenames, add timestamps, or any other custom behavior, `stouch` has got you covered.\n\n## Features\n\n- **Extensible**: Easily add new functionalities with plugins.\n- **Built-in Plugins**: Comes with a slugify plugin out of the box.\n- **Easy to Use**: Simple CLI interface powered by Typer.\n\n## Installation\n\nUsing poetry:\n\n```bash\npoetry install stouch\n```\n\nTo install with the slugify plugin:\n\n```bash\npoetry install stouch[slugify]\n```\n\n## Usage\n\nBasic usage:\n\n```bash\nstouch filename.txt\n```\n\nUsing the slugify plugin:\n\n```bash\nstouch \"My New File.txt\" --plugin=slugify\n```\n\n## Developing Plugins\n\nCheck out our [plugin development guide](LINK_TO_PLUGIN_GUIDE) to learn how to create your own plugins for `stouch`.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Contributing\n\nContributions are welcome! Please read our [contributing guidelines](LINK_TO_CONTRIBUTING_GUIDE) to get started.\n\n## Acknowledgements\n\n- [Typer](https://typer.tiangolo.com/) for the CLI framework.\n- [python-slugify](https://pypi.org/project/python-slugify/) for the slugification utility.\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An extensible touch command with plugin support, allowing for enhanced file creation capabilities.",
"version": "0.1.0.post1",
"project_urls": {
"Homepage": "https://github.com/azataiot/stouch"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b6d803662226dc31ac26ad9236f12844fad865d365cb39d9a3a6d1cfee74d1c",
"md5": "a17876488df771a32cdf13dd993e1d92",
"sha256": "f023f18391c19a35f5160d8dba0acf566021a939c3952d84bb0cf0b3b0a66305"
},
"downloads": -1,
"filename": "stouch-0.1.0.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a17876488df771a32cdf13dd993e1d92",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 4215,
"upload_time": "2023-09-07T09:29:04",
"upload_time_iso_8601": "2023-09-07T09:29:04.844823Z",
"url": "https://files.pythonhosted.org/packages/6b/6d/803662226dc31ac26ad9236f12844fad865d365cb39d9a3a6d1cfee74d1c/stouch-0.1.0.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "470e98e994687dc8668bee815cba30751920541cf19650fac4697bcd7d43b7a0",
"md5": "187c80841f2cdfed8f13a16d2b9500e9",
"sha256": "188d15fd76ec5ced4dd185e5d41faabab0e3e9d0d8def93bc31e4f31bcfac123"
},
"downloads": -1,
"filename": "stouch-0.1.0.post1.tar.gz",
"has_sig": false,
"md5_digest": "187c80841f2cdfed8f13a16d2b9500e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 3216,
"upload_time": "2023-09-07T09:29:07",
"upload_time_iso_8601": "2023-09-07T09:29:07.342308Z",
"url": "https://files.pythonhosted.org/packages/47/0e/98e994687dc8668bee815cba30751920541cf19650fac4697bcd7d43b7a0/stouch-0.1.0.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-07 09:29:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "azataiot",
"github_project": "stouch",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "stouch"
}
