stellapy


Namestellapy JSON
Version 0.1.2 PyPI version JSON
download
home_pagehttps://github.com/Shravan-1908/stellapy
SummaryStreamline your web dev experience with stella.
upload_time2021-06-14 15:20:22
maintainer
docs_urlNone
authorShravan Asati
requires_python
licenseMIT
keywords web dev development website python cli stella reloader walker executor helium selenium automation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # stella

[![](https://img.shields.io/github/license/Shravan-1908/stellapy?style=for-the-badge)]()
[![](https://img.shields.io/github/issues/Shravan-1908/stellapy?style=for-the-badge)]()
[![](https://img.shields.io/github/workflow/status/Shravan-1908/stellapy/Linting/main?style=for-the-badge)]()
[![](https://img.shields.io/pypi/pyversions/stellapy?style=for-the-badge)]()
[![](https://img.shields.io/pypi/v/stellapy?style=for-the-badge)]()

stella is a command line utility made for streamlining web development experience. It is able to reload server as well as browser on every file change.

<br>


## 📝 Table of Contents
- [Installation](#-installation)
- [Motivation](#-motivation)
- [How does stella work?](#-how-does-stella-work?)
- [Usage](#-usage)
- [Changelog](#-changelog)
- [Versioning](#-versioning)
- [Licensing](#-licensing)
- [Contribution](#-contribution)


<br>


## ⚡️ Installation

On Windows:
```
pip install stellapy
```

On Linux/MacOS:
```
pip3 install stellapy
```

Or if you're using [pipx](https://pypa.github.io/pipx/):
```
pipx install stellapy
```


<br>



## 💫 Motivation

I wanted a CLI that could reload the browser for static content as well as restart the server for the dynamic content. I tried to find such a tool, but didn't find one. So I made stella - that could reload backend as well as frontend code.

<br>

## ⚙️ How does stella work?

stella continuously watches for file changes in the project (html, css, js, py, rb, go, rs, php, java) and whenever a change is made, it kills the existing process and spawns a new process using subprocess. What about browser reload? It uses selenium to accomplish browser reload.

<br>


## 💡 Usage

This section briefly describes how to use the stella CLI.

### config

```
stella config {options}
```

The `config` command is used to configure stella. The only option for *v0.1.0* is browser. When stella is ran for the first time, it automcatically configures chrome as the browser to start and perform reload actions on. However, if you want stella to use firefox, execute:

```
stella config --browser=firefox
```

### run

```
stella run COMMAND URL
```

The `run` command is used to start stella.
It expects two arguments:

1. `command` --> The shell command to execute on every file reload. Example:
`python3 app.py`.

2. `url` --> The URL to listen at the browser. Whenever a file is changed, stella will execute the shell command provided and then reload the browser. Example: `localhost:5000`.

Example:
```
stella run "python3 app.py" localhost:5000
```

While stella is running, you can input `rs` to restart the server and reload the browser again. 

To stop stella, input `ex`. It will close the browser as well as kill the running process gracefully.

**It is strongly recommended to not to stop stella abruptly by pressing Ctrl+C. This will keep the process running in the background, which might create problems for you.**

<br>


## ⏪ Changelog
The changes made in the latest version of *stella*, v0.1.0 are:

- Initial release

View [CHANGELOG.md](CHANGELOG.md) for more information.

<br>


## 🔖 Versioning

stella releases follow semantic versioning, every release is in the *x.y.z* form, where:

- x is the MAJOR version and is incremented when a backwards incompatible change to stella is made.
- y is the MINOR version and is incremented when a backwards compatible change to stella is made, like changing dependencies or adding a new function, method, or features.
- z is the PATCH version and is incremented after making minor changes that don't affect stella's public API or dependencies, like fixing a bug.

<br>

## 📄 Licensing

License © 2021-Present Shravan Asati

This repository is licensed under the MIT license. See [LICENSE](LICENSE) for details.

<br>

## 👥 Contribution

Contribution is more than welcome. For more guidelines on contributing to stella, refer [CONTRIBUTING.md](CONTRIBUTING.md).


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Shravan-1908/stellapy",
    "name": "stellapy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "web dev,development,website,python,cli,stella,reloader,walker,executor,helium,selenium,automation",
    "author": "Shravan Asati",
    "author_email": "dev.shravan@protonmail.com",
    "download_url": "https://files.pythonhosted.org/packages/7d/c9/dc529847faf46a2fd0166ee5050733690ee47a7a68aa18f540ebfbde222d/stellapy-0.1.2.tar.gz",
    "platform": "",
    "description": "# stella\n\n[![](https://img.shields.io/github/license/Shravan-1908/stellapy?style=for-the-badge)]()\n[![](https://img.shields.io/github/issues/Shravan-1908/stellapy?style=for-the-badge)]()\n[![](https://img.shields.io/github/workflow/status/Shravan-1908/stellapy/Linting/main?style=for-the-badge)]()\n[![](https://img.shields.io/pypi/pyversions/stellapy?style=for-the-badge)]()\n[![](https://img.shields.io/pypi/v/stellapy?style=for-the-badge)]()\n\nstella is a command line utility made for streamlining web development experience. It is able to reload server as well as browser on every file change.\n\n<br>\n\n\n## \ud83d\udcdd Table of Contents\n- [Installation](#-installation)\n- [Motivation](#-motivation)\n- [How does stella work?](#-how-does-stella-work?)\n- [Usage](#-usage)\n- [Changelog](#-changelog)\n- [Versioning](#-versioning)\n- [Licensing](#-licensing)\n- [Contribution](#-contribution)\n\n\n<br>\n\n\n## \u26a1\ufe0f Installation\n\nOn Windows:\n```\npip install stellapy\n```\n\nOn Linux/MacOS:\n```\npip3 install stellapy\n```\n\nOr if you're using [pipx](https://pypa.github.io/pipx/):\n```\npipx install stellapy\n```\n\n\n<br>\n\n\n\n## \ud83d\udcab Motivation\n\nI wanted a CLI that could reload the browser for static content as well as restart the server for the dynamic content. I tried to find such a tool, but didn't find one. So I made stella - that could reload backend as well as frontend code.\n\n<br>\n\n## \u2699\ufe0f How does stella work?\n\nstella continuously watches for file changes in the project (html, css, js, py, rb, go, rs, php, java) and whenever a change is made, it kills the existing process and spawns a new process using subprocess. What about browser reload? It uses selenium to accomplish browser reload.\n\n<br>\n\n\n## \ud83d\udca1 Usage\n\nThis section briefly describes how to use the stella CLI.\n\n### config\n\n```\nstella config {options}\n```\n\nThe `config` command is used to configure stella. The only option for *v0.1.0* is browser. When stella is ran for the first time, it automcatically configures chrome as the browser to start and perform reload actions on. However, if you want stella to use firefox, execute:\n\n```\nstella config --browser=firefox\n```\n\n### run\n\n```\nstella run COMMAND URL\n```\n\nThe `run` command is used to start stella.\nIt expects two arguments:\n\n1. `command` --> The shell command to execute on every file reload. Example:\n`python3 app.py`.\n\n2. `url` --> The URL to listen at the browser. Whenever a file is changed, stella will execute the shell command provided and then reload the browser. Example: `localhost:5000`.\n\nExample:\n```\nstella run \"python3 app.py\" localhost:5000\n```\n\nWhile stella is running, you can input `rs` to restart the server and reload the browser again. \n\nTo stop stella, input `ex`. It will close the browser as well as kill the running process gracefully.\n\n**It is strongly recommended to not to stop stella abruptly by pressing Ctrl+C. This will keep the process running in the background, which might create problems for you.**\n\n<br>\n\n\n## \u23ea Changelog\nThe changes made in the latest version of *stella*, v0.1.0 are:\n\n- Initial release\n\nView [CHANGELOG.md](CHANGELOG.md) for more information.\n\n<br>\n\n\n## \ud83d\udd16 Versioning\n\nstella releases follow semantic versioning, every release is in the *x.y.z* form, where:\n\n- x is the MAJOR version and is incremented when a backwards incompatible change to stella is made.\n- y is the MINOR version and is incremented when a backwards compatible change to stella is made, like changing dependencies or adding a new function, method, or features.\n- z is the PATCH version and is incremented after making minor changes that don't affect stella's public API or dependencies, like fixing a bug.\n\n<br>\n\n## \ud83d\udcc4 Licensing\n\nLicense \u00a9 2021-Present Shravan Asati\n\nThis repository is licensed under the MIT license. See [LICENSE](LICENSE) for details.\n\n<br>\n\n## \ud83d\udc65 Contribution\n\nContribution is more than welcome. For more guidelines on contributing to stella, refer [CONTRIBUTING.md](CONTRIBUTING.md).\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Streamline your web dev experience with stella.",
    "version": "0.1.2",
    "split_keywords": [
        "web dev",
        "development",
        "website",
        "python",
        "cli",
        "stella",
        "reloader",
        "walker",
        "executor",
        "helium",
        "selenium",
        "automation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "bf2771e376a1282f88d1f7fef1d3e88c",
                "sha256": "dc25bc62afb5be4472d55cae6c9eb09e58942a3997e1a4e29d2e11e6334c5a60"
            },
            "downloads": -1,
            "filename": "stellapy-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bf2771e376a1282f88d1f7fef1d3e88c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8774,
            "upload_time": "2021-06-14T15:20:20",
            "upload_time_iso_8601": "2021-06-14T15:20:20.698270Z",
            "url": "https://files.pythonhosted.org/packages/a3/b4/dfd247e86615ea2219eeab922cbb8fda93892030e40c756fb55d76a4aec8/stellapy-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "eccc16cca1ae8c95b0d1680fbf4fb22f",
                "sha256": "fa24fc1fc7a2789037d6c4589c086e77bf2b14b85e0652a12538e9df69dcc085"
            },
            "downloads": -1,
            "filename": "stellapy-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "eccc16cca1ae8c95b0d1680fbf4fb22f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8623,
            "upload_time": "2021-06-14T15:20:22",
            "upload_time_iso_8601": "2021-06-14T15:20:22.174922Z",
            "url": "https://files.pythonhosted.org/packages/7d/c9/dc529847faf46a2fd0166ee5050733690ee47a7a68aa18f540ebfbde222d/stellapy-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-06-14 15:20:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "Shravan-1908",
    "error": "Could not fetch GitHub repository",
    "lcname": "stellapy"
}
        
Elapsed time: 0.25658s