startwork


Namestartwork JSON
Version 0.1.3 PyPI version JSON
download
home_page
SummarySmall CLI to easier start and swap between projects in different stacks.
upload_time2023-03-21 23:34:10
maintainer
docs_urlNone
authorJorbFreire
requires_python
license
keywords python inquirer cli dev-tools tooling
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# Start-Work

<!-- badges start -->
![GitHub repo size](https://img.shields.io/github/repo-size/JorbFreire/startwork?style=plastic)
[![Publish](https://github.com/JorbFreire/startwork/workflows/Publish/badge.svg)](https://github.com/JorbFreire/startwork/actions?query=workflow:"Publish")
[![GitHub release](https://img.shields.io/github/release/JorbFreire/startwork?include_prereleases=&sort=semver&color=blue)](https://github.com/JorbFreire/startwork/releases/)
[![License](https://img.shields.io/badge/License-MIT-blue)](#license)
![OS - Linux](https://img.shields.io/badge/OS-Linux-blue?logo=linux&logoColor=white)
[![dependency - StartWork](https://img.shields.io/badge/dependency-StartWork-blue?logo=python&logoColor=white)](https://pypi.org/project/StartWork)
[![Github](https://img.shields.io/badge/Github-purple?logo=github)](https://github.com/JorbFreire/startwork)
<!-- badges end -->

Small CLI to easier start and swap between projects in different stacks.

## motivation

It's not hard to set up and run most modern software projects.

Usually, we just have to run two something like `pip install -r requirements.txt`
 and `flask run` or something similar. The real problem comes we you have to
 constantly switch contexts, even worse when working with multiple projects in
 multiple languages with totally different setups a couple of times a day.

[Docker](https://www.docker.com/) and [DockerCompose](https://docs.docker.com/compose/) are great tools to handle this problem. Start Work
 should not be a replacement for Docker either Docker compose and shall even
 work with both.

With Start-Work will be easier to switch between projects from any folder and
 get your development environment up and running only by selecting the project
 you wanna work on, and when some of these projects for some reason don't allow 
 Docker, Start-Work will also try to identify which tools you are using and run
 it for you.

## Installation

Just run:
```bash
pip install startwork
```

It's done, the installation can be verified with:
```bash
work --version
```

## CLI Options


```bash
work
```
Will display a list and let you select one of your saved projects

<br />

```bash
work create
```
Will guide you with a couple of questions to save a new project.

<br />

```bash
work delete
```
Will display a list and let delete one of your saved projects.

Note: it will not remove the project from your computer, only from the list on
 Start-Work

<br />

```bash
work --version
```
Show current version

<br />

```bash
work --help
```
Show currently available CLI options

## Next goals

- [ ] Handle multiple environments in a single folder
  - [ ] Detect multiple environments
  - [ ] Let you choose the environment that will be run
  - [ ] Let you mark multiple to run at the same time


- [ ] Handle multiple folders
  - [ ] When not matched by any setup pattern, check inside the first children's folders
  - [ ] When multiple children folders match, let you choose one folder
  - [ ] Let you mark multiple folders to run at the same time

- [ ] Handle multiple folders AND multiple environments at the same call
- [ ] Write fully covered end-to-end tests



            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "startwork",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "python,inquirer,cli,dev-tools,tooling",
    "author": "JorbFreire",
    "author_email": "jorbfreire@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/50/3c/575e6985aae2b611baf036beed380886c85d32f38f496605176532b9618c/startwork-0.1.3.tar.gz",
    "platform": null,
    "description": "\n# Start-Work\n\n<!-- badges start -->\n![GitHub repo size](https://img.shields.io/github/repo-size/JorbFreire/startwork?style=plastic)\n[![Publish](https://github.com/JorbFreire/startwork/workflows/Publish/badge.svg)](https://github.com/JorbFreire/startwork/actions?query=workflow:\"Publish\")\n[![GitHub release](https://img.shields.io/github/release/JorbFreire/startwork?include_prereleases=&sort=semver&color=blue)](https://github.com/JorbFreire/startwork/releases/)\n[![License](https://img.shields.io/badge/License-MIT-blue)](#license)\n![OS - Linux](https://img.shields.io/badge/OS-Linux-blue?logo=linux&logoColor=white)\n[![dependency - StartWork](https://img.shields.io/badge/dependency-StartWork-blue?logo=python&logoColor=white)](https://pypi.org/project/StartWork)\n[![Github](https://img.shields.io/badge/Github-purple?logo=github)](https://github.com/JorbFreire/startwork)\n<!-- badges end -->\n\nSmall CLI to easier start and swap between projects in different stacks.\n\n## motivation\n\nIt's not hard to set up and run most modern software projects.\n\nUsually, we just have to run two something like `pip install -r requirements.txt`\n and `flask run` or something similar. The real problem comes we you have to\n constantly switch contexts, even worse when working with multiple projects in\n multiple languages with totally different setups a couple of times a day.\n\n[Docker](https://www.docker.com/) and [DockerCompose](https://docs.docker.com/compose/) are great tools to handle this problem. Start Work\n should not be a replacement for Docker either Docker compose and shall even\n work with both.\n\nWith Start-Work will be easier to switch between projects from any folder and\n get your development environment up and running only by selecting the project\n you wanna work on, and when some of these projects for some reason don't allow \n Docker, Start-Work will also try to identify which tools you are using and run\n it for you.\n\n## Installation\n\nJust run:\n```bash\npip install startwork\n```\n\nIt's done, the installation can be verified with:\n```bash\nwork --version\n```\n\n## CLI Options\n\n\n```bash\nwork\n```\nWill display a list and let you select one of your saved projects\n\n<br />\n\n```bash\nwork create\n```\nWill guide you with a couple of questions to save a new project.\n\n<br />\n\n```bash\nwork delete\n```\nWill display a list and let delete one of your saved projects.\n\nNote: it will not remove the project from your computer, only from the list on\n Start-Work\n\n<br />\n\n```bash\nwork --version\n```\nShow current version\n\n<br />\n\n```bash\nwork --help\n```\nShow currently available CLI options\n\n## Next goals\n\n- [ ] Handle multiple environments in a single folder\n  - [ ] Detect multiple environments\n  - [ ] Let you choose the environment that will be run\n  - [ ] Let you mark multiple to run at the same time\n\n\n- [ ] Handle multiple folders\n  - [ ] When not matched by any setup pattern, check inside the first children's folders\n  - [ ] When multiple children folders match, let you choose one folder\n  - [ ] Let you mark multiple folders to run at the same time\n\n- [ ] Handle multiple folders AND multiple environments at the same call\n- [ ] Write fully covered end-to-end tests\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Small CLI to easier start and swap between projects in different stacks.",
    "version": "0.1.3",
    "split_keywords": [
        "python",
        "inquirer",
        "cli",
        "dev-tools",
        "tooling"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6ec97c355870e79794fd685314a7d6f9e33d3a432b80eb41e213dd56ece5089d",
                "md5": "e4d73f5a980992356b2496f0ea9abd27",
                "sha256": "be400d60f4aaadb1e87b22ce2353100a9bdca5ed748ecb433530e8a872278370"
            },
            "downloads": -1,
            "filename": "startwork-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e4d73f5a980992356b2496f0ea9abd27",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 12835,
            "upload_time": "2023-03-21T23:34:09",
            "upload_time_iso_8601": "2023-03-21T23:34:09.261146Z",
            "url": "https://files.pythonhosted.org/packages/6e/c9/7c355870e79794fd685314a7d6f9e33d3a432b80eb41e213dd56ece5089d/startwork-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "503c575e6985aae2b611baf036beed380886c85d32f38f496605176532b9618c",
                "md5": "9005780b69deb33caf98bcfa98af2fb2",
                "sha256": "160c1abc6894285cfefe29494a5c4be829e91265638576cd2ec3d36372f78f4c"
            },
            "downloads": -1,
            "filename": "startwork-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "9005780b69deb33caf98bcfa98af2fb2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10120,
            "upload_time": "2023-03-21T23:34:10",
            "upload_time_iso_8601": "2023-03-21T23:34:10.839374Z",
            "url": "https://files.pythonhosted.org/packages/50/3c/575e6985aae2b611baf036beed380886c85d32f38f496605176532b9618c/startwork-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-21 23:34:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "startwork"
}
        
Elapsed time: 1.21726s