| Name | upset-alttxt JSON |
| Version |
0.4.5
JSON |
| download |
| home_page | None |
| Summary | Generates alt text for UpSet plots |
| upload_time | 2024-12-02 21:48:42 |
| maintainer | None |
| docs_url | None |
| author | Visualization Design Lab |
| requires_python | >=3.8 |
| license | BSD3 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# :sparkles: upset-alt-txt-gen 
Design experiments for generating semantically meaningful alt-text for UpSet Plots.
## Local Deployment
1. Clone the repository using `git clone` or download and extract the zip file.
2. Ensure you have python version >= 3.8.10 installed.
3. Open a terminal in the repository directory and create and activate a python virtual environment running at least Python 3.8.10. For information on how to do this, navigate [here](https://docs.python.org/3/library/venv.html).
4. Install the required dependencies using `pip install -r requirements.txt`.
5. (Optional) Install the required development dependencies using `pip install -r requirements_dev.txt`. These are only required if you plan on running the tests or linting.
6. Install the alttxt module in development mode with `pip install -e .`
To run the program with the example data, run `python [path/to/alttxt directory] --data ../../data/movie_data_card_sort.json`
Level and granularity can be changed to any of the options listed in [Command Line Options](#command-line-options).
Here is an example command:
For unix/macOS: `python3 src/alttxt --data data/movie_data_dev_sort.json`
For Windows: `python src/alttxt --data data/movie_data_dev_sort.json`
## Local Testing
Local testing can be done using the `tox` command. Tests have not been updated to match the latest updates to the repository, and updating them is currently on hold, as deployment is a priority over robustness.
- Linting: To run the linting tests, run `tox -e lint`
- Type: To run the type tests, run `tox -e type`
- Tests: To run the python tests, run `tox -e test`
- Formatting: To automatically format the files to match the `flake8-black` standards, run `tox -e format`
To run the entire suite of tests at once, use `tox`.
## Command Line Options
| Command | Description |
|------------------------|-------------------------------------------------------------------------------------------------|
| `-h`, `--help` | Show information on each command and exit. |
| `-V`, `--version` | Show the program version number and exit. |
| `-D`, `--data` | (Required) Relative path to data file. |
| `-l`, `--level` | Semantic level. Defaults to a combination of all levels. Options are: `1`, `2`. |
| `-st`, `--structured` | Returns information in JSON format that contains structured text (long description), alt-txt (short description), and technical description of the plot making strategy |
| `-t`, `--title` | A title for the plot; used in some generations. Defaults to `has no title`. |
|------------------------| -------------------------------------------------------------------------------------------------|
Raw data
{
"_id": null,
"home_page": null,
"name": "upset-alttxt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Visualization Design Lab",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b0/d5/70ade18e97b28b51151c3d9f090fe2df1eb28a46a224109b5d26f6bab43b/upset-alttxt-0.4.5.tar.gz",
"platform": "unix",
"description": "# :sparkles: upset-alt-txt-gen \nDesign experiments for generating semantically meaningful alt-text for UpSet Plots.\n\n## Local Deployment\n\n1. Clone the repository using `git clone` or download and extract the zip file.\n2. Ensure you have python version >= 3.8.10 installed.\n3. Open a terminal in the repository directory and create and activate a python virtual environment running at least Python 3.8.10. For information on how to do this, navigate [here](https://docs.python.org/3/library/venv.html).\n4. Install the required dependencies using `pip install -r requirements.txt`.\n5. (Optional) Install the required development dependencies using `pip install -r requirements_dev.txt`. These are only required if you plan on running the tests or linting.\n6. Install the alttxt module in development mode with `pip install -e .`\n\n\nTo run the program with the example data, run `python [path/to/alttxt directory] --data ../../data/movie_data_card_sort.json`\nLevel and granularity can be changed to any of the options listed in [Command Line Options](#command-line-options).\nHere is an example command:\n For unix/macOS: `python3 src/alttxt --data data/movie_data_dev_sort.json`\n For Windows: `python src/alttxt --data data/movie_data_dev_sort.json`\n\n## Local Testing\n\nLocal testing can be done using the `tox` command. Tests have not been updated to match the latest updates to the repository, and updating them is currently on hold, as deployment is a priority over robustness.\n\n- Linting: To run the linting tests, run `tox -e lint`\n- Type: To run the type tests, run `tox -e type`\n- Tests: To run the python tests, run `tox -e test`\n- Formatting: To automatically format the files to match the `flake8-black` standards, run `tox -e format`\n\nTo run the entire suite of tests at once, use `tox`.\n\n## Command Line Options\n\n| Command | Description |\n|------------------------|-------------------------------------------------------------------------------------------------|\n| `-h`, `--help` | Show information on each command and exit. |\n| `-V`, `--version` | Show the program version number and exit. |\n| `-D`, `--data` | (Required) Relative path to data file. |\n| `-l`, `--level` | Semantic level. Defaults to a combination of all levels. Options are: `1`, `2`. |\n| `-st`, `--structured` | Returns information in JSON format that contains structured text (long description), alt-txt (short description), and technical description of the plot making strategy |\n| `-t`, `--title` | A title for the plot; used in some generations. Defaults to `has no title`. |\n|------------------------| -------------------------------------------------------------------------------------------------| \n",
"bugtrack_url": null,
"license": "BSD3",
"summary": "Generates alt text for UpSet plots",
"version": "0.4.5",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ff045f444bf133292cffc3f71a491485aa334bd836be26b4d5ee23f2d6d643ab",
"md5": "4fd779612be94194a4e18fb3a127a0fe",
"sha256": "ed3fc64e1b42414e886dc287268b327c48e420cfff5771dc0249e4bdab8b5dbd"
},
"downloads": -1,
"filename": "upset_alttxt-0.4.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4fd779612be94194a4e18fb3a127a0fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 28120,
"upload_time": "2024-12-02T21:48:41",
"upload_time_iso_8601": "2024-12-02T21:48:41.287394Z",
"url": "https://files.pythonhosted.org/packages/ff/04/5f444bf133292cffc3f71a491485aa334bd836be26b4d5ee23f2d6d643ab/upset_alttxt-0.4.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b0d570ade18e97b28b51151c3d9f090fe2df1eb28a46a224109b5d26f6bab43b",
"md5": "053ea84fce7320afb51829246613baa4",
"sha256": "1d277895eda1892768719f2eb0a962b7308e57730aebcc8b945ab8b46fdcd12a"
},
"downloads": -1,
"filename": "upset-alttxt-0.4.5.tar.gz",
"has_sig": false,
"md5_digest": "053ea84fce7320afb51829246613baa4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27486,
"upload_time": "2024-12-02T21:48:42",
"upload_time_iso_8601": "2024-12-02T21:48:42.273908Z",
"url": "https://files.pythonhosted.org/packages/b0/d5/70ade18e97b28b51151c3d9f090fe2df1eb28a46a224109b5d26f6bab43b/upset-alttxt-0.4.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 21:48:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "upset-alttxt"
}
