# Star - Command Line Tool
Star is a command-line tool designed to simplify project setup, testing, and development tasks by providing a unified interface for running scripts and commands. It allows you to define and manage scripts in a configuration file, making it easy to execute complex workflows with a single command.
## Features
- **Script Configuration**: Define scripts in a configuration file (`star.json`) to specify tasks for setup, testing, or development.
- **Unified Interface**: Run scripts using a single command, reducing the need to remember complex command sequences.
- **Flexibility**: Execute both single commands and sequences of commands defined in the configuration file.
- **Easy to Use**: Simplify your workflow by streamlining common tasks with predefined scripts.
## Installation
Star can be installed using `pip`. Open a terminal and run:
```bash
pip install python-star
```
## Documentation (Usage)
#### Adding Commands
Define your custom scripts in the star.json file located in the root directory of your project. Example:
```json
{
"scripts": {
"custom_script": "echo 'Running custom script'",
"test": ["echo 'Test 1 Pass'", "echo 'Test 1 Pass'"]
}
}
```
### Running Commands
To run a script, use the following command:
```bash
star <script-name>
```
Replace `<script-name>` with the name of the script defined in your star.json file.
### Example
Assuming you have a star.json file with the following content:
```json
{
"scripts": {
"setup": "python setup.py",
"test": ["pytest", "flake8"]
}
}
```
You can run the "setup" script using
```bash
star setup
```
Or run the "test" script sequence using:
```bash
star test
```
### Other Command
| Short Form | Long Form | Description |
| ---------- | --------- | ------------------------------- |
| -h | --help | Show this help message and exit |
| -v | --version | Display the version of Star |
| -l | --list | List all available scripts |
## Contributing
For guidance on setting up a development environment and how to make a contribution to Star, see the
Raw data
{
"_id": null,
"home_page": "https://github.com/sikandar1838/star",
"name": "python-star",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "CLI,project setup,testing,development,automation,scripting,workflow,convenience,productivity,deployment,utility,developer tool,single command",
"author": "Sikandar Moyal",
"author_email": "sikandar1838@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/97/ec/d71fe87a69b47093cc5b9e53c653f6f278c0979c8106a9632ebc95dfee31/python-star-0.1.0.tar.gz",
"platform": null,
"description": "# Star - Command Line Tool\r\n\r\nStar is a command-line tool designed to simplify project setup, testing, and development tasks by providing a unified interface for running scripts and commands. It allows you to define and manage scripts in a configuration file, making it easy to execute complex workflows with a single command.\r\n\r\n## Features\r\n\r\n- **Script Configuration**: Define scripts in a configuration file (`star.json`) to specify tasks for setup, testing, or development.\r\n\r\n- **Unified Interface**: Run scripts using a single command, reducing the need to remember complex command sequences.\r\n\r\n- **Flexibility**: Execute both single commands and sequences of commands defined in the configuration file.\r\n\r\n- **Easy to Use**: Simplify your workflow by streamlining common tasks with predefined scripts.\r\n\r\n## Installation\r\n\r\nStar can be installed using `pip`. Open a terminal and run:\r\n\r\n```bash\r\npip install python-star\r\n```\r\n\r\n## Documentation (Usage)\r\n\r\n#### Adding Commands\r\n\r\nDefine your custom scripts in the star.json file located in the root directory of your project. Example:\r\n\r\n```json\r\n{\r\n\t\"scripts\": {\r\n\t\t\"custom_script\": \"echo 'Running custom script'\",\r\n\t\t\"test\": [\"echo 'Test 1 Pass'\", \"echo 'Test 1 Pass'\"]\r\n\t}\r\n}\r\n```\r\n\r\n### Running Commands\r\n\r\nTo run a script, use the following command:\r\n\r\n```bash\r\nstar <script-name>\r\n```\r\n\r\nReplace `<script-name>` with the name of the script defined in your star.json file.\r\n\r\n### Example\r\n\r\nAssuming you have a star.json file with the following content:\r\n\r\n```json\r\n{\r\n\t\"scripts\": {\r\n\t\t\"setup\": \"python setup.py\",\r\n\t\t\"test\": [\"pytest\", \"flake8\"]\r\n\t}\r\n}\r\n```\r\n\r\nYou can run the \"setup\" script using\r\n\r\n```bash\r\nstar setup\r\n```\r\n\r\nOr run the \"test\" script sequence using:\r\n\r\n```bash\r\nstar test\r\n```\r\n\r\n### Other Command\r\n\r\n| Short Form | Long Form | Description |\r\n| ---------- | --------- | ------------------------------- |\r\n| -h | --help | Show this help message and exit |\r\n| -v | --version | Display the version of Star |\r\n| -l | --list | List all available scripts |\r\n\r\n## Contributing\r\n\r\nFor guidance on setting up a development environment and how to make a contribution to Star, see the\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command-line tool for simplifying project setup and development tasks.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/sikandar1838/star"
},
"split_keywords": [
"cli",
"project setup",
"testing",
"development",
"automation",
"scripting",
"workflow",
"convenience",
"productivity",
"deployment",
"utility",
"developer tool",
"single command"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20b76a5843721c45e9c1d2ff54aa3f878e6d9d2365be7075dc3ad71dcdfafabd",
"md5": "8cfef8437353d066522dbb167531bc2d",
"sha256": "82caa63ff144c524efb763cc7bacb54707c96e8cef2a9dff3ac2eaefe6f9ba5f"
},
"downloads": -1,
"filename": "python_star-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8cfef8437353d066522dbb167531bc2d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4873,
"upload_time": "2024-01-25T16:31:55",
"upload_time_iso_8601": "2024-01-25T16:31:55.112545Z",
"url": "https://files.pythonhosted.org/packages/20/b7/6a5843721c45e9c1d2ff54aa3f878e6d9d2365be7075dc3ad71dcdfafabd/python_star-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97ecd71fe87a69b47093cc5b9e53c653f6f278c0979c8106a9632ebc95dfee31",
"md5": "b1aca174417cf9e890e25c3e26977066",
"sha256": "578d6c952aafc73d20612904d9a0085139a5a943abb71f95f0ed43f6c182920e"
},
"downloads": -1,
"filename": "python-star-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b1aca174417cf9e890e25c3e26977066",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4238,
"upload_time": "2024-01-25T16:31:58",
"upload_time_iso_8601": "2024-01-25T16:31:58.276822Z",
"url": "https://files.pythonhosted.org/packages/97/ec/d71fe87a69b47093cc5b9e53c653f6f278c0979c8106a9632ebc95dfee31/python-star-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-25 16:31:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sikandar1838",
"github_project": "star",
"github_not_found": true,
"lcname": "python-star"
}
JSON
