# Zin
zin is a lightweight command management tool that simplifies scripting and task automation. It provides an simple interface for defining and executing custom commands, helping you streamline your workflows and boost productivity.
## Features ✨
- Command Definition: Easily define custom commands using a YAML configuration file.
- Command Execution: Use a straightforward command-line interface to carry out the commands you've specified.
- Modeled after [Rav](https://github.com/jmitchel3/rav): The flexibility and ease-of-use of the command-line program [Rav](https://github.com/jmitchel3/rav) serve as inspiration for zin.
## Usage
To install `zin`, you can use pip:
```bash
pip install zin
```
## Configuration
Make sure that 'zin.yaml' is present in the root working directory of your project before using 'zin'. But running 'zin' for the first time will automatically create the file if it doesn't already exist.
The `zin.yaml` file follows a simple and easy-to-use format. Start with the `scripts:` section, followed by the command names and their corresponding commands. You can include multiple commands for a single command name using YAML collections.
Example `zin.yaml` configuration:<br>
(this is just an example for demonstration purposes.)
```yaml
scripts:
tests: python -m pytest --cov=my_module tests/
build:
- rm -rf dist/
- venv/bin/python3 -m build
- venv/bin/pip uninstall rav
- venv/bin/pip install -e .
```
Feel free to add more commands as needed.
**To run a command** using `zin`, you can use the following syntax:
```bash
zin run <command_name>
```
**To list all the commands** using `zin`, you can use the following syntax:
```bash
zin list
```
## Contributing 🤝
Contributions are encouraged! Please start an issue or submit a pull request if you want to share thoughts, ideas, or problem reports. As stated in the [CONTRIBUTING.md](CONTRIBUTING.md) file, be sure that you stick to the guidelines.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
---
**Note:** zin is highly inspired by [Rav](https://github.com/jmitchel3/rav), a command-line tool developed by [Justin Mitchel](https://github.com/jmitchel3).
**Happy coding with zin! 😁**
---
**Project Renamed: pep is now zin. We apologize for any confusion caused.**
Raw data
{
"_id": null,
"home_page": "https://github.com/dishansa/zin",
"name": "zin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "tools,zin,automation,command management,script",
"author": "Dishan Sachin",
"author_email": "dishansachin99@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/38/31/604dfa594c83f711436eaa00235c3073f2a0041f9c560fa8e2a4896a5397/zin-1.0.1.tar.gz",
"platform": null,
"description": "# Zin\n\nzin is a lightweight command management tool that simplifies scripting and task automation. It provides an simple interface for defining and executing custom commands, helping you streamline your workflows and boost productivity.\n\n## Features \u2728\n\n- Command Definition: Easily define custom commands using a YAML configuration file.\n- Command Execution: Use a straightforward command-line interface to carry out the commands you've specified.\n- Modeled after [Rav](https://github.com/jmitchel3/rav): The flexibility and ease-of-use of the command-line program [Rav](https://github.com/jmitchel3/rav) serve as inspiration for zin.\n\n## Usage\n\nTo install `zin`, you can use pip:\n\n```bash\npip install zin\n```\n\n## Configuration \n\nMake sure that 'zin.yaml' is present in the root working directory of your project before using 'zin'. But running 'zin' for the first time will automatically create the file if it doesn't already exist.\n\nThe `zin.yaml` file follows a simple and easy-to-use format. Start with the `scripts:` section, followed by the command names and their corresponding commands. You can include multiple commands for a single command name using YAML collections.\n\nExample `zin.yaml` configuration:<br>\n(this is just an example for demonstration purposes.)\n\n```yaml\nscripts:\n tests: python -m pytest --cov=my_module tests/\n build:\n - rm -rf dist/\n - venv/bin/python3 -m build\n - venv/bin/pip uninstall rav\n - venv/bin/pip install -e .\n```\n\nFeel free to add more commands as needed.\n\n**To run a command** using `zin`, you can use the following syntax:\n\n```bash\nzin run <command_name>\n```\n\n**To list all the commands** using `zin`, you can use the following syntax:\n\n```bash\nzin list\n``` \n\n## Contributing \ud83e\udd1d\n\nContributions are encouraged! Please start an issue or submit a pull request if you want to share thoughts, ideas, or problem reports. As stated in the [CONTRIBUTING.md](CONTRIBUTING.md) file, be sure that you stick to the\u00a0guidelines.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.\n\n---\n\n**Note:** zin is highly inspired by [Rav](https://github.com/jmitchel3/rav), a command-line tool developed by [Justin Mitchel](https://github.com/jmitchel3).\n\n**Happy coding with zin! \ud83d\ude01**\n\n---\n\n**Project Renamed: pep is now zin. We apologize for any confusion caused.**\n",
"bugtrack_url": null,
"license": "",
"summary": "zin is a lightweight command management tool that simplifies scripting and task automation.",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/dishansa/zin",
"Repository": "https://github.com/dishansa/zin"
},
"split_keywords": [
"tools",
"zin",
"automation",
"command management",
"script"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6599313f28b490cbb530e5541969978ef9e91609b5fbd382cd70192588e542ca",
"md5": "ca562936ea8e2d69b81ad828ebf7f796",
"sha256": "6ff67f83242a883df9b22f8cc665090ff4f6e0026fce5f175ca9aba6abde901d"
},
"downloads": -1,
"filename": "zin-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca562936ea8e2d69b81ad828ebf7f796",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5967,
"upload_time": "2023-06-13T17:47:56",
"upload_time_iso_8601": "2023-06-13T17:47:56.195381Z",
"url": "https://files.pythonhosted.org/packages/65/99/313f28b490cbb530e5541969978ef9e91609b5fbd382cd70192588e542ca/zin-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3831604dfa594c83f711436eaa00235c3073f2a0041f9c560fa8e2a4896a5397",
"md5": "ab3739d9fbe897f6b6ee2afe71e730ee",
"sha256": "fb78576840de8b68d509f056fbab00364eafa764d8ae4382093fa90035958435"
},
"downloads": -1,
"filename": "zin-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "ab3739d9fbe897f6b6ee2afe71e730ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4935,
"upload_time": "2023-06-13T17:47:58",
"upload_time_iso_8601": "2023-06-13T17:47:58.243820Z",
"url": "https://files.pythonhosted.org/packages/38/31/604dfa594c83f711436eaa00235c3073f2a0041f9c560fa8e2a4896a5397/zin-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-13 17:47:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dishansa",
"github_project": "zin",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "zin"
}
JSON
