Generates alt text for UpSet plots
Project description
:sparkles: upset-alt-txt-gen 
Design experiments for generating semantically meaningful alt-text for UpSet Plots.
Local Deployment
- Clone the repository using
git cloneor download and extract the zip file. - Ensure you have python version >= 3.8.10 installed.
- 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.
- Install the required dependencies using
pip install -r requirements.txt. - (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. - 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.
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-blackstandards, runtox -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. |
| ------------------------ | ------------------------------------------------------------------------------------------------- |
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file upset-alttxt-0.3.3.tar.gz.
File metadata
- Download URL: upset-alttxt-0.3.3.tar.gz
- Upload date:
- Size: 24.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b33597764e4ebd65b07bcdde7ff8c7351d38cba4191bf5c4849439c3c3d1e98a |
|
| MD5 | ef1c1d68a835b77d36b225439e49c5e8 |
|
| BLAKE2b-256 | 28ab0af73863516b3cb9e15e46a07b0540b3d4f1faa64becf3113a2baf8ebfc8 |
File details
Details for the file upset_alttxt-0.3.3-py3-none-any.whl.
File metadata
- Download URL: upset_alttxt-0.3.3-py3-none-any.whl
- Upload date:
- Size: 25.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 58c05caae658f16a3e429ae84aa8ace838425793b56ba19e995c4bc1b06db664 |
|
| MD5 | c8ffb9ea031c921f990735cb804fb372 |
|
| BLAKE2b-256 | 73fd84ad55c15f0abcba082b10429d55630e27486e6e2031afa550757e1b1842 |
