# StateSXT
<br/>
## How to Install?
There are two approaches to install the package:
- Manually cloning the project in Github repository: [statesxt](https://github.com/jsonnnnn/statesxt)
- Using `pip`, that the package is hosted in [here](https://pypi.org/project/statesxt/#description) <b>(recommended)</b>.
``` console
pip install statesxt
```
> **Note:** It is always better to install the package in a virtual environment.
## How to Use?
- Generate the template
``` console
statesxt generate
```
- Remove the template
``` console
statesxt remove
```
- Update the template
``` console
statesxt update
```
- Generate a new page template (inside /testcases)
``` console
statesxt create-page
```
## How to Update?
Currently, the package can not be updated through usual command `pip install --upgrade statesxt`. Probably because is hosted in TestPypi.
So, for the time being, user have to reinstall the package.
## How to Uninstall?
There are two approaches to uninstall the package:
- Uninstalling only the package
``` console
pip uninstall statesxt
```
- Uninstalling the package and its dependencies <b>(vulnerable)</b>.
To do this, the user must install a package called `pip-autoremove` (if not already installed).
``` console
pip install pip-autoremove
```
Once the package is installed, user can now uninstall the package with the following command.
``` console
pip-autoremove statesxt -y
```
Note: If there is an error saying that `ModuleNotFoundError: No module named 'pip_autoremove'`, you could try to move the `pip_autoremove.py` file from `./Scripts` into `./Lib` instead. For further information: [here](https://stackoverflow.com/questions/74523001/modulenotfounderror-when-trying-to-use-pip-autoremove).
## How to Test?
There is a tox.ini file inside .\statesxt\, where you can just execute it by invoking `tox -c .\statesxt\` in terminal. But anyway, that is to test manually in your local, meanwhile there is .github\ that enables to testing with Github Actions, where it works by triggering the execution of `tox.ini` once you make a commit. So basically, it has implemented CI/CD.
## License
This project is licensed under the [MIT License](https://github.com/cjsonnnnn/statesxt?tab=MIT-1-ov-file).
Raw data
{
"_id": null,
"home_page": "https://test.pypi.org/project/statesxt/",
"name": "statesxt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Selenium, Pytest, Python, project template, template, Testing, Framework",
"author": "Jason Caleb",
"author_email": "cjsonnnnn@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/42/e6/7586c58e536c1d1e969a3108d62d8fe6ee8f3caf1fb4d375162f79adf377/statesxt-0.5.13.tar.gz",
"platform": null,
"description": "# StateSXT\r\n\r\n\r\n<br/>\r\n\r\n## How to Install?\r\nThere are two approaches to install the package:\r\n- Manually cloning the project in Github repository: [statesxt](https://github.com/jsonnnnn/statesxt)\r\n- Using `pip`, that the package is hosted in [here](https://pypi.org/project/statesxt/#description) <b>(recommended)</b>. \r\n ``` console\r\n pip install statesxt\r\n ```\r\n\r\n> **Note:** It is always better to install the package in a virtual environment.\r\n\r\n## How to Use?\r\n- Generate the template\r\n ``` console\r\n statesxt generate\r\n ```\r\n- Remove the template\r\n ``` console\r\n statesxt remove\r\n ```\r\n- Update the template\r\n ``` console\r\n statesxt update\r\n ```\r\n- Generate a new page template (inside /testcases)\r\n ``` console\r\n statesxt create-page\r\n ```\r\n\r\n\r\n## How to Update?\r\nCurrently, the package can not be updated through usual command `pip install --upgrade statesxt`. Probably because is hosted in TestPypi.\r\nSo, for the time being, user have to reinstall the package.\r\n\r\n\r\n## How to Uninstall?\r\nThere are two approaches to uninstall the package:\r\n- Uninstalling only the package\r\n ``` console\r\n pip uninstall statesxt\r\n ```\r\n- Uninstalling the package and its dependencies <b>(vulnerable)</b>.\r\n To do this, the user must install a package called `pip-autoremove` (if not already installed).\r\n ``` console\r\n pip install pip-autoremove\r\n ```\r\n Once the package is installed, user can now uninstall the package with the following command.\r\n ``` console\r\n pip-autoremove statesxt -y\r\n ```\r\n Note: If there is an error saying that `ModuleNotFoundError: No module named 'pip_autoremove'`, you could try to move the `pip_autoremove.py` file from `./Scripts` into `./Lib` instead. For further information: [here](https://stackoverflow.com/questions/74523001/modulenotfounderror-when-trying-to-use-pip-autoremove).\r\n\r\n\r\n## How to Test?\r\nThere is a tox.ini file inside .\\statesxt\\, where you can just execute it by invoking `tox -c .\\statesxt\\` in terminal. But anyway, that is to test manually in your local, meanwhile there is .github\\ that enables to testing with Github Actions, where it works by triggering the execution of `tox.ini` once you make a commit. So basically, it has implemented CI/CD. \r\n\r\n\r\n## License\r\nThis project is licensed under the [MIT License](https://github.com/cjsonnnnn/statesxt?tab=MIT-1-ov-file).\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A project template for testing your website application.",
"version": "0.5.13",
"project_urls": {
"Documentation": "https://statesxt.readthedocs.io/en/latest/",
"Homepage": "https://test.pypi.org/project/statesxt/",
"Source": "https://github.com/jsonnnnn/statesxt"
},
"split_keywords": [
"selenium",
" pytest",
" python",
" project template",
" template",
" testing",
" framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac8d5076c5d93c346141fae7291ecf53ed4a53f80edf718ebfbe1047ba85148a",
"md5": "a374625ecfcf8314468483fbc7c19dca",
"sha256": "95d94d4445e39ce5f5dfb253a46d9ea5a27b5421c77864862e1fdf3932667992"
},
"downloads": -1,
"filename": "statesxt-0.5.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a374625ecfcf8314468483fbc7c19dca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 600075,
"upload_time": "2024-07-04T16:54:47",
"upload_time_iso_8601": "2024-07-04T16:54:47.229462Z",
"url": "https://files.pythonhosted.org/packages/ac/8d/5076c5d93c346141fae7291ecf53ed4a53f80edf718ebfbe1047ba85148a/statesxt-0.5.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "42e67586c58e536c1d1e969a3108d62d8fe6ee8f3caf1fb4d375162f79adf377",
"md5": "472898124a28022b65a6630ec1b2d248",
"sha256": "84b63ffb07faf6333c1dead203596a357c446da5f26e4049c3f43d3eab131da0"
},
"downloads": -1,
"filename": "statesxt-0.5.13.tar.gz",
"has_sig": false,
"md5_digest": "472898124a28022b65a6630ec1b2d248",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 589006,
"upload_time": "2024-07-04T16:54:51",
"upload_time_iso_8601": "2024-07-04T16:54:51.273284Z",
"url": "https://files.pythonhosted.org/packages/42/e6/7586c58e536c1d1e969a3108d62d8fe6ee8f3caf1fb4d375162f79adf377/statesxt-0.5.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-04 16:54:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jsonnnnn",
"github_project": "statesxt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "statesxt"
}
JSON
