# Tipytools
Tipytools is a Python library that simplifies the development of command-line tools by providing a collection of command-line tool templates and utilities. It offers features such as project setup, template-based file generation, logging, and integration with the fire library for creating user-friendly command-line interfaces.
## Features
- **Project setup made easy**: Use the `setup` command to quickly set up your project by initializing the environment and generating the project structure for your command-line tool.
- **Template-based project structure**: Tipytools provides a standardized project structure including essential files like README.md, setup.py, and template files for your tool's implementation.
- **Logging utility**: The library includes a logging module that allows easy printing of information, warnings, errors, and success messages with customizable colors.
- **Cross-platform compatibility**: Tipytools is designed to work seamlessly on Windows, Linux, and macOS, ensuring compatibility across different platforms.
- **Integration with fire library**: Tipytools integrates with the fire library to provide a user-friendly and intuitive command-line interface for your generated tools.
- **Optional virtual environment**: If you want to set up the project without a virtual environment, you can use the `maketool` command to generate only the folder structure without creating a virtual environment.
## Folder Structure
The folder structure for Tipytools is as follows:
```
Tipytools/
├── package_test/
│ └── test.py
├── [tool_name]/
│ ├── init.py
│ ├── [tool_name].py
│ └── logger.py
├── README.md
└── setup.py
```
## Installation:
```shell
pip install tipytool
```
You can install Tipytools directly from the GitHub repository:
```shell
pip install git+https://github.com/tipytools/tipytools.git
```
## Usage
1. Set up your project:
- To create a virtual environment and generate the project structure, run the `setup` command and specify the tool name and optional virtual environment name.
- Example: `tipy setup tool=[toolname] [optional: env=[venvname]]`
- To generate only the folder structure without a virtual environment, run the `maketool` command and specify the tool name.
- Example: `tipy maketool [toolname]`
2. Implement your tool's logic within the generated files and customize as needed.
3. Run your tool from the command line: Use the tool name followed by the desired command and arguments.
- Example: `[toolname] [command] [arguments]`
During the project setup, Tipytools will initialize the environment by creating a virtual environment using the specified name (or a default name derived from the tool name). It will then generate the project structure, including the necessary files and directories. After the setup is complete, you can start implementing your tool's functionality within the provided template files.
Please refer to the [documentation](https://github.com/tipytools/tipytools) available in the repository for more detailed information, usage examples, and customization options.
Contributions, bug reports, and feature requests are welcome! Feel free to submit issues and pull requests on [GitHub](https://github.com/tipytools/tipytools) to help improve Tipytools.
- version: 1.0.0
- author: Mauly dotDev
Raw data
{
"_id": null,
"home_page": "",
"name": "tipytool",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "command-line interface,development tools,Python library,CLI utilities,project scaffolding,automation,code generation,tooling,software development,command-line applications",
"author": "",
"author_email": "Mauly dotDev <mauly.dev@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e2/cc/c9190b2cb9915733e67d9299d4e8394394a1945e646f36ebc25b3d1f6477/tipytool-1.0.3.tar.gz",
"platform": null,
"description": "\n\n# Tipytools\n\n Tipytools is a Python library that simplifies the development of command-line tools by providing a collection of command-line tool templates and utilities. It offers features such as project setup, template-based file generation, logging, and integration with the fire library for creating user-friendly command-line interfaces.\n\n## Features\n\n- **Project setup made easy**: Use the `setup` command to quickly set up your project by initializing the environment and generating the project structure for your command-line tool.\n- **Template-based project structure**: Tipytools provides a standardized project structure including essential files like README.md, setup.py, and template files for your tool's implementation.\n- **Logging utility**: The library includes a logging module that allows easy printing of information, warnings, errors, and success messages with customizable colors.\n- **Cross-platform compatibility**: Tipytools is designed to work seamlessly on Windows, Linux, and macOS, ensuring compatibility across different platforms.\n- **Integration with fire library**: Tipytools integrates with the fire library to provide a user-friendly and intuitive command-line interface for your generated tools.\n- **Optional virtual environment**: If you want to set up the project without a virtual environment, you can use the `maketool` command to generate only the folder structure without creating a virtual environment.\n\n## Folder Structure\n\nThe folder structure for Tipytools is as follows:\n\n```\nTipytools/\n\u251c\u2500\u2500 package_test/\n\u2502 \u2514\u2500\u2500 test.py\n\u251c\u2500\u2500 [tool_name]/\n\u2502 \u251c\u2500\u2500 init.py\n\u2502 \u251c\u2500\u2500 [tool_name].py\n\u2502 \u2514\u2500\u2500 logger.py\n\u251c\u2500\u2500 README.md\n\u2514\u2500\u2500 setup.py\n```\n\n## Installation:\n\n```shell\npip install tipytool\n```\n\nYou can install Tipytools directly from the GitHub repository:\n\n```shell\npip install git+https://github.com/tipytools/tipytools.git\n```\n\n## Usage\n\n1. Set up your project:\n - To create a virtual environment and generate the project structure, run the `setup` command and specify the tool name and optional virtual environment name.\n - Example: `tipy setup tool=[toolname] [optional: env=[venvname]]`\n - To generate only the folder structure without a virtual environment, run the `maketool` command and specify the tool name.\n - Example: `tipy maketool [toolname]`\n2. Implement your tool's logic within the generated files and customize as needed.\n3. Run your tool from the command line: Use the tool name followed by the desired command and arguments.\n - Example: `[toolname] [command] [arguments]`\n\nDuring the project setup, Tipytools will initialize the environment by creating a virtual environment using the specified name (or a default name derived from the tool name). It will then generate the project structure, including the necessary files and directories. After the setup is complete, you can start implementing your tool's functionality within the provided template files.\n\nPlease refer to the [documentation](https://github.com/tipytools/tipytools) available in the repository for more detailed information, usage examples, and customization options.\n\nContributions, bug reports, and feature requests are welcome! Feel free to submit issues and pull requests on [GitHub](https://github.com/tipytools/tipytools) to help improve Tipytools.\n\n- version: 1.0.0\n- author: Mauly dotDev\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A tool for generating boilerplate for creating command-line tools",
"version": "1.0.3",
"project_urls": null,
"split_keywords": [
"command-line interface",
"development tools",
"python library",
"cli utilities",
"project scaffolding",
"automation",
"code generation",
"tooling",
"software development",
"command-line applications"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbbc2d88aaba331a99779deccea625dbe5b13517a0bc1256d926a4657556e9dd",
"md5": "fa7426208965e2e652053e53c412b4a5",
"sha256": "91f77d5504bbde672be90f3c9df7d885971c89b8ba783a07abfea64cb3d4ee79"
},
"downloads": -1,
"filename": "tipytool-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa7426208965e2e652053e53c412b4a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 112246,
"upload_time": "2023-07-09T01:14:20",
"upload_time_iso_8601": "2023-07-09T01:14:20.499564Z",
"url": "https://files.pythonhosted.org/packages/bb/bc/2d88aaba331a99779deccea625dbe5b13517a0bc1256d926a4657556e9dd/tipytool-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e2ccc9190b2cb9915733e67d9299d4e8394394a1945e646f36ebc25b3d1f6477",
"md5": "28e624a796d6493af4dd65500692af3b",
"sha256": "f9224ee23027bdc7936ff81168508e1ea989965d38a18dc66669b9e9c4fb5bbd"
},
"downloads": -1,
"filename": "tipytool-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "28e624a796d6493af4dd65500692af3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 56500,
"upload_time": "2023-07-09T01:14:22",
"upload_time_iso_8601": "2023-07-09T01:14:22.031538Z",
"url": "https://files.pythonhosted.org/packages/e2/cc/c9190b2cb9915733e67d9299d4e8394394a1945e646f36ebc25b3d1f6477/tipytool-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-09 01:14:22",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tipytool"
}
JSON