| Name | harness-tui JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | A text user interface for managing and interacting with harness.io |
| upload_time | 2024-07-03 04:36:12 |
| maintainer | None |
| docs_url | None |
| author | z3z1ma |
| requires_python | <3.13,>3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Harness TUI
A [Textual](https://https://textual.textualize.io/) App that allows you to interact with your [Harness](https://harness.io/) account.
## Installation
### Prerequisites
- Python 3.9 or higher
- [Pipx](https://pipxproject.github.io/pipx/) (optional, but recommended)
### Using pipx
The recommended way to install the app is to use [pipx](https://pipxproject.github.io/pipx/). This will install the app in an isolated environment and make it available globally.
```bash
pipx install harness-tui
```
### Using pip
You can also install the app using pip. This will install the app in the user's environment.
```bash
# Optionally create a virtual environment for the tool
# python -m venv /opt/harness-tui/.venv
# source /opt/harness-tui/.venv/bin/activate
pip install harness-tui
# echo "export PATH=\$PATH:/opt/harness-tui/.venv/bin" >> ~/.bashrc
```
## Development
- Clone the repository
- Run `make install-dev` to create a virtual environment and install the dependencies
- Run `source .venv/bin/activate` to activate the virtual environment
### Using direnv
As an alternative to manually activating the virtual environment, you can use [direnv](https://direnv.net/). To do so, follow these steps:
- Install direnv: `brew install direnv`
- Add the following line to your shell configuration file (e.g. `~/.bashrc`, `~/.zshrc`): `eval "$(direnv hook bash)"`
- Create a `.envrc` file in the project root with the following content:
```bash
export VIRTUAL_ENV=.venv
dotenv
layout python
```
- Run `touch .env` to create the `.env` file
- Run `direnv allow` to allow the `.envrc` file
Now the virtual environment will be activated automatically when you `cd` into the project directory. Furthermore all environment variables defined in the `.env` file will be loaded.
### Developing the app
Refer the textual docs and the harness API docs for most of the information we need to develop the app.
### Running the app
To run the app, you can use the `make run` command. This will start the app in the terminal.
Alternatively, just run the app directly:
```bash
python src/harness_tui/app.py
```
### Up to date dependencies
If the requirements file has been updated, you can run `make install-dev` to update the dependencies in the virtual environment.
### Roadmap
We will graduate the project from a requirements txt managed project to a poetry managed project with a pyproject.toml that will allow us to publish the project to PyPi for distribution.
Raw data
{
"_id": null,
"home_page": null,
"name": "harness-tui",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>3.9",
"maintainer_email": null,
"keywords": null,
"author": "z3z1ma",
"author_email": "butler.alex2010@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/af/2d/19aa73941aa03c4ca32c5d8ef6f246df3a6d87d3faae2ad1d278b938d21f/harness_tui-0.1.2.tar.gz",
"platform": null,
"description": "# Harness TUI\n\nA [Textual](https://https://textual.textualize.io/) App that allows you to interact with your [Harness](https://harness.io/) account.\n\n## Installation\n\n### Prerequisites\n\n- Python 3.9 or higher\n- [Pipx](https://pipxproject.github.io/pipx/) (optional, but recommended)\n\n\n### Using pipx\n\nThe recommended way to install the app is to use [pipx](https://pipxproject.github.io/pipx/). This will install the app in an isolated environment and make it available globally.\n\n```bash\npipx install harness-tui\n```\n\n### Using pip\n\nYou can also install the app using pip. This will install the app in the user's environment.\n\n```bash\n# Optionally create a virtual environment for the tool\n# python -m venv /opt/harness-tui/.venv\n# source /opt/harness-tui/.venv/bin/activate\npip install harness-tui\n# echo \"export PATH=\\$PATH:/opt/harness-tui/.venv/bin\" >> ~/.bashrc\n```\n\n## Development\n\n- Clone the repository\n- Run `make install-dev` to create a virtual environment and install the dependencies\n- Run `source .venv/bin/activate` to activate the virtual environment\n\n### Using direnv\n\nAs an alternative to manually activating the virtual environment, you can use [direnv](https://direnv.net/). To do so, follow these steps:\n\n- Install direnv: `brew install direnv`\n- Add the following line to your shell configuration file (e.g. `~/.bashrc`, `~/.zshrc`): `eval \"$(direnv hook bash)\"`\n- Create a `.envrc` file in the project root with the following content:\n\n```bash\nexport VIRTUAL_ENV=.venv\ndotenv\nlayout python\n```\n\n- Run `touch .env` to create the `.env` file\n- Run `direnv allow` to allow the `.envrc` file\n\nNow the virtual environment will be activated automatically when you `cd` into the project directory. Furthermore all environment variables defined in the `.env` file will be loaded.\n\n\n### Developing the app\n\nRefer the textual docs and the harness API docs for most of the information we need to develop the app.\n\n### Running the app\n\nTo run the app, you can use the `make run` command. This will start the app in the terminal.\n\nAlternatively, just run the app directly:\n\n```bash\npython src/harness_tui/app.py\n```\n\n\n### Up to date dependencies\n\nIf the requirements file has been updated, you can run `make install-dev` to update the dependencies in the virtual environment.\n\n### Roadmap\n\nWe will graduate the project from a requirements txt managed project to a poetry managed project with a pyproject.toml that will allow us to publish the project to PyPi for distribution.\n",
"bugtrack_url": null,
"license": null,
"summary": "A text user interface for managing and interacting with harness.io",
"version": "0.1.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b09dfa70ff59cec38a15fe8272b466d324b75dbf282cc098e74aae5bea04d4e",
"md5": "0f1328f432b0208978e937d0a7749050",
"sha256": "08d2c5f05c65b6eaacdfc5d681ee1de59fed05e0025e1cc03b7350629cd1f6e3"
},
"downloads": -1,
"filename": "harness_tui-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f1328f432b0208978e937d0a7749050",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>3.9",
"size": 24511,
"upload_time": "2024-07-03T04:36:11",
"upload_time_iso_8601": "2024-07-03T04:36:11.689377Z",
"url": "https://files.pythonhosted.org/packages/8b/09/dfa70ff59cec38a15fe8272b466d324b75dbf282cc098e74aae5bea04d4e/harness_tui-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "af2d19aa73941aa03c4ca32c5d8ef6f246df3a6d87d3faae2ad1d278b938d21f",
"md5": "ac601b6fe214cc51f5987c37d71dda2e",
"sha256": "ccb24fb91976b62dcea420ae2516485d559c99fce47dcd7375b3e502e27d2ad0"
},
"downloads": -1,
"filename": "harness_tui-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "ac601b6fe214cc51f5987c37d71dda2e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>3.9",
"size": 19744,
"upload_time": "2024-07-03T04:36:12",
"upload_time_iso_8601": "2024-07-03T04:36:12.755552Z",
"url": "https://files.pythonhosted.org/packages/af/2d/19aa73941aa03c4ca32c5d8ef6f246df3a6d87d3faae2ad1d278b938d21f/harness_tui-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-03 04:36:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "harness-tui"
}
