Skip to main content

Generates alt text for UpSet plots

Project description

:sparkles: upset-alt-txt-gen Tests

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.
  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. 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.
------------------------ -------------------------------------------------------------------------------------------------

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

upset-alttxt-0.4.3.tar.gz (26.5 kB view details)

Uploaded Source

Built Distribution

upset_alttxt-0.4.3-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

Details for the file upset-alttxt-0.4.3.tar.gz.

File metadata

  • Download URL: upset-alttxt-0.4.3.tar.gz
  • Upload date:
  • Size: 26.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for upset-alttxt-0.4.3.tar.gz
Algorithm Hash digest
SHA256 7977a6a82599bee5758ae4199d07ff8215ecfe18892e1a4c809ef32d70227505
MD5 782e808d97b3b73291b917f7f86d035c
BLAKE2b-256 871a7f0d3f05f08f09aa4b9a8b647ae2adabdc8d15ac521c06975b7d77db154b

See more details on using hashes here.

File details

Details for the file upset_alttxt-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: upset_alttxt-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 27.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for upset_alttxt-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 400a2c3a862a6339124cf3c9bfd1ec12c5d389e16fa340c2ed7d921fab151e9e
MD5 52b0a22d552f0bcbb451a3ce0f6d54c6
BLAKE2b-256 3dbbab0977ad3ed8d7c3cacb0cfbf5918f7ffccc851feaf4bb084b668b43c803

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page