Quansight-Labs · gabalafou · Mar 28, 2024 · Feb 23, 2024 · Feb 23, 2024 · Feb 23, 2024
diff --git a/.github/workflows/preview-pr.yml b/.github/workflows/preview-pr.yml
@@ -33,7 +33,7 @@ jobs:
 
     - name: Build the demo pages 📚
       run: |
-        python test/run_css.py --save-dir docs
+        python tests/run_css.py --save-dir docs
 
     - name: Deploy PR Preview
       uses: rossjrw/pr-preview-action@v1.2.0
@@ -74,7 +74,7 @@ jobs:
 
     - name: Build the demo pages 📚
       run: |
-        python test/run_css.py --save-dir docs
+        python tests/run_css.py --save-dir docs
 
     - name: Setup Pages 🛠
       uses: actions/configure-pages@v3

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -29,7 +29,7 @@ repos:
     rev: 24.1.1
     hooks:
       - id: black
-        exclude: ^test/scripts/
+        exclude: ^tests/scripts/
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.2.0

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -55,17 +55,18 @@ You will need to have the following installed locally:
 
    ```console
     $ hatch env show
-   ┏━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┓
-   ┃ Name    ┃ Type    ┃ Dependencies ┃ Scripts     ┃
-   ┡━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━┩
-   │ default │ virtual │              │             │
-   ├─────────┼─────────┼──────────────┼─────────────┤
-   │ dev     │ virtual │              │ css         │
-   │         │         │              │ render_html │
-   ├─────────┼─────────┼──────────────┼─────────────┤
-   │ test    │ virtual │ hypothesis   │ tests       │
-   │         │         │ pytest       │             │
-   └─────────┴─────────┴──────────────┴─────────────┘
+   ┏━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
+   ┃ Name    ┃ Type    ┃ Dependencies ┃ Scripts        ┃
+   ┡━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
+   │ default │ virtual │              │                │
+   ├─────────┼─────────┼──────────────┼────────────────┤
+   │ dev     │ virtual │              │ css            │
+   │         │         │              │ render_html    │
+   |         |         |              | update_readmes |
+   ├─────────┼─────────┼──────────────┼────────────────┤
+   │ test    │ virtual │ hypothesis   │ tests          │
+   │         │         │ pytest       │                │
+   └─────────┴─────────┴──────────────┴────────────────┘
    ```
 
 Alternatively you can use conda to create your environment:
@@ -94,7 +95,7 @@ You can generate individual HTML files for each of the themes included in `acces
 hatch run dev:render_html
 ```
 
-This will add the HTML files under `test/results` for each supported theme.
+This will add the HTML files under `tests/results` for each supported theme.
 We recommend using your favorite browser to see the rich HTML output.
 
 ## Adding a new theme 🎨
@@ -133,15 +134,17 @@ While working on your theme, it might be helpful to generate the individual HTML
 hatch dev:render_html
 ```
 
-If successful, you should be able to see the results of your new theme under `test/results/<your-theme>`.
+If successful, you should be able to see the results of your new theme under `tests/results/<your-theme>`.
 
 ### Update the `README.md` file
 
-Once you are happy with the colors and the rules in the style file, please update the README for your new theme!
+Once you are happy with the colors and the rules in the style file, please update the README for your new theme! You can generate a README with the following command:
 
-The **most** important part for us, is to add a table with the contrast ratios of the colors you've chosen and their compliance to WCAG. Please use any of the current themes as a base, and use any color contrast checker to fill it out.
+```py
+hatch dev:update_readmes --theme your-theme-name
+```
 
-Any acknowledgements to other repositories that you may use as base please add them as well to the main [README](./README.md) in the repo under the `acknowledgements` section.
+This script will generate a table of contrast ratios of the colors you've chosen and their compliance with WCAG. It will also pull the docstring from the `Theme` class and put it in the README as the description for your theme. If you are porting a theme or color palette developed elsewhere please acknowledge your source(s) in the docstring of the `Theme` class.
 
 Also, don't forget to add the name of your theme to our list of supported themes in the main README.
 

diff --git a/README.md b/README.md
@@ -69,7 +69,7 @@ You can install it through the following commands:
 ```bash
 conda install -c conda-forge accessible-pygments
 
-# if you prefer using mambga
+# if you prefer using mamba
 mamba install -c conda-forge accessible-pygments
 ```
 

diff --git a/a11y_pygments/a11y_dark/README.md b/a11y_pygments/a11y_dark/README.md
@@ -1,8 +1,10 @@
-# A11y dark
+# A11Y Dark
 
-This is the pygments implementation of [`a11y dark`](https://github.com/ericwbailey/a11y-syntax-highlighting)
+This is the Pygments implementation of a11y-dark from [Eric Bailey's
+accessible themes for syntax
+highlighting](https://github.com/ericwbailey/a11y-syntax-highlighting)
 
-![Screenshot of the dark accessibility theme in a bash script](./images/a11y-dark.png)
+![Screenshot of the a11y-dark theme in a bash script](./images/a11y-dark.png)
 
 ## Colors
 
@@ -12,13 +14,20 @@ Highlight color: ![#ffd9002e](https://via.placeholder.com/20/ffd9002e/ffd9002e.p
 
 **WCAG compliance**
 
-| Color                                                        | Hex       | Ratio     | Normal text | Large text |
-| ------------------------------------------------------------ | --------- | --------- | ----------- | ---------- |
-| ![#d4d0ab](https://via.placeholder.com/20/d4d0ab/d4d0ab.png) | `#d4d0ab` | 9.04 : 1  | AAA         | AAA        |
-| ![#ffa07a](https://via.placeholder.com/20/ffa07a/ffa07a.png) | `#ffa07a` | 7.12 : 1  | AAA         | AAA        |
-| ![#f5ab35](https://via.placeholder.com/20/f5ab35/f5ab35.png) | `#f5ab35` | 7.25 : 1  | AAA         | AAA        |
-| ![#ffd700](https://via.placeholder.com/20/ffd700/ffd700.png) | `#ffd700` | 10.09 : 1 | AAA         | AAA        |
-| ![#abe338](https://via.placeholder.com/20/abe338/abe338.png) | `#abe338` | 9.29 : 1  | AAA         | AAA        |
-| ![#00e0e0](https://via.placeholder.com/20/00e0e0/00e0e0.png) | `#00e0e0` | 8.59 : 1  | AAA         | AAA        |
-| ![#dcc6e0](https://via.placeholder.com/20/dcc6e0/dcc6e0.png) | `#dcc6e0` | 8.9 : 1   | AAA         | AAA        |
-| ![#f8f8f2](https://via.placeholder.com/20/f8f8f2/f8f8f2.png) | `#f8f8f2` | 13.28 : 1 | AAA         | AAA        |
+| Color                                                        | Hex       | Ratio   | Normal text | Large text |
+| ------------------------------------------------------------ | --------- | ------- | ----------- | ---------- |
+| ![#d4d0ab](https://via.placeholder.com/20/d4d0ab/d4d0ab.png) | `#d4d0ab` | 9.0 : 1 | AAA         | AAA        |
+
+| ![#ffa07a](https://via.placeholder.com/20/ffa07a/ffa07a.png) | `#ffa07a` | 7.1 : 1 | AAA | AAA |
+
+| ![#f5ab35](https://via.placeholder.com/20/f5ab35/f5ab35.png) | `#f5ab35` | 7.3 : 1 | AAA | AAA |
+
+| ![#ffd700](https://via.placeholder.com/20/ffd700/ffd700.png) | `#ffd700` | 10.1 : 1 | AAA | AAA |
+
+| ![#abe338](https://via.placeholder.com/20/abe338/abe338.png) | `#abe338` | 9.3 : 1 | AAA | AAA |
+
+| ![#00e0e0](https://via.placeholder.com/20/00e0e0/00e0e0.png) | `#00e0e0` | 8.6 : 1 | AAA | AAA |
+
+| ![#dcc6e0](https://via.placeholder.com/20/dcc6e0/dcc6e0.png) | `#dcc6e0` | 8.9 : 1 | AAA | AAA |
+
+| ![#f8f8f2](https://via.placeholder.com/20/f8f8f2/f8f8f2.png) | `#f8f8f2` | 13.3 : 1 | AAA | AAA |
diff --git a/a11y_pygments/a11y_dark/images/a11y-dark.png b/a11y_pygments/a11y_dark/images/a11y-dark.png
diff --git a/a11y_pygments/a11y_dark/style.py b/a11y_pygments/a11y_dark/style.py
@@ -28,7 +28,9 @@ class Colors:
 
 class Theme(Style):
     """
-    This style mimics the a11 light theme from eric bailey's accessible themes.
+    This is the Pygments implementation of a11y-dark from [Eric Bailey's
+    accessible themes for syntax
+    highlighting](https://github.com/ericwbailey/a11y-syntax-highlighting)
     """
 
     default_style = ""

diff --git a/a11y_pygments/a11y_high_contrast_dark/README.md b/a11y_pygments/a11y_high_contrast_dark/README.md
@@ -1,8 +1,8 @@
-# A11y dark high contrast
+# A11Y High Contrast Dark
 
-This is the pygments implementation of [`a11y dark`](https://github.com/ericwbailey/a11y-syntax-highlighting) with high contrast.
+This style mimics the a11 light theme from eric bailey's accessible themes.
 
-![Screenshot of the dark accessibility theme in a bash script](./images/a11y-high-contrast-dark.png)
+![Screenshot of the a11y-high-contrast-dark theme in a bash script](./images/a11y-high-contrast-dark.png)
 
 ## Colors
 
@@ -12,11 +12,16 @@ Highlight color: ![#ffd9002e](https://via.placeholder.com/20/ffd9002e/ffd9002e.p
 
 **WCAG compliance**
 
-| Color                                                        | Hex       | Ratio     | Normal text | Large text |
-| ------------------------------------------------------------ | --------- | --------- | ----------- | ---------- |
-| ![#ffa07a](https://via.placeholder.com/20/ffa07a/ffa07a.png) | `#ffa07a` | 7.12 : 1  | AAA         | AAA        |
-| ![#ffd900](https://via.placeholder.com/20/ffd900/ffd900.png) | `#ffd900` | 10.23 : 1 | AAA         | AAA        |
-| ![#abe338](https://via.placeholder.com/20/abe338/abe338.png) | `#abe338` | 9.29 : 1  | AAA         | AAA        |
-| ![#00e0e0](https://via.placeholder.com/20/00e0e0/00e0e0.png) | `#00e0e0` | 8.59 : 1  | AAA         | AAA        |
-| ![#dcc6e0](https://via.placeholder.com/20/dcc6e0/dcc6e0.png) | `#dcc6e0` | 8.9 : 1   | AAA         | AAA        |
-| ![#f8f8f2](https://via.placeholder.com/20/f8f8f2/f8f8f2.png) | `#f8f8f2` | 13.28 : 1 | AAA         | AAA        |
+| Color                                                        | Hex       | Ratio    | Normal text | Large text |
+| ------------------------------------------------------------ | --------- | -------- | ----------- | ---------- |
+| ![#ffd900](https://via.placeholder.com/20/ffd900/ffd900.png) | `#ffd900` | 10.2 : 1 | AAA         | AAA        |
+
+| ![#ffa07a](https://via.placeholder.com/20/ffa07a/ffa07a.png) | `#ffa07a` | 7.1 : 1 | AAA | AAA |
+
+| ![#abe338](https://via.placeholder.com/20/abe338/abe338.png) | `#abe338` | 9.3 : 1 | AAA | AAA |
+
+| ![#00e0e0](https://via.placeholder.com/20/00e0e0/00e0e0.png) | `#00e0e0` | 8.6 : 1 | AAA | AAA |
+
+| ![#dcc6e0](https://via.placeholder.com/20/dcc6e0/dcc6e0.png) | `#dcc6e0` | 8.9 : 1 | AAA | AAA |
+
+| ![#f8f8f2](https://via.placeholder.com/20/f8f8f2/f8f8f2.png) | `#f8f8f2` | 13.3 : 1 | AAA | AAA |
diff --git a/a11y_pygments/a11y_high_contrast_dark/images/a11y-high-contrast-dark.png b/a11y_pygments/a11y_high_contrast_dark/images/a11y-high-contrast-dark.png
diff --git a/a11y_pygments/a11y_high_contrast_light/README.md b/a11y_pygments/a11y_high_contrast_light/README.md
@@ -1,8 +1,8 @@
-# A11y light high contrast
+# A11Y High Contrast Light
 
-This is the pygments implementation of [`a11y light`](https://github.com/ericwbailey/a11y-syntax-highlighting) with high contrast.
+This style mimics the a11 light theme from eric bailey's accessible themes.
 
-![Screenshot of the light accessibility theme in a bash script](./images/a11y-high-contrast-light.png)
+![Screenshot of the a11y-high-contrast-light theme in a bash script](./images/a11y-high-contrast-light.png)
 
 ## Colors
 
@@ -12,11 +12,16 @@ Highlight color: ![#7971292e](https://via.placeholder.com/20/7971292e/7971292e.p
 
 **WCAG compliance**
 
-| Color                                                        | Hex       | Ratio    | Normal text | Large text |
-| ------------------------------------------------------------ | --------- | -------- | ----------- | ---------- |
-| ![#d91e18](https://via.placeholder.com/20/d91e18/d91e18.png) | `#d91e18` | 5.02 : 1 | AA          | AAA        |
-| ![#797129](https://via.placeholder.com/20/797129/797129.png) | `#797129` | 4.87 : 1 | AA          | AAA        |
-| ![#008000](https://via.placeholder.com/20/008000/008000.png) | `#008000` | 5.09 : 1 | AA          | AAA        |
-| ![#007faa](https://via.placeholder.com/20/007faa/007faa.png) | `#007faa` | 4.51 : 1 | AA          | AAA        |
-| ![#7928a1](https://via.placeholder.com/20/7928a1/7928a1.png) | `#7928a1` | 7.91 : 1 | AAA         | AAA        |
-| ![#545454](https://via.placeholder.com/20/545454/545454.png) | `#545454` | 7.51 : 1 | AAA         | AAA        |
+| Color                                                        | Hex       | Ratio   | Normal text | Large text |
+| ------------------------------------------------------------ | --------- | ------- | ----------- | ---------- |
+| ![#797129](https://via.placeholder.com/20/797129/797129.png) | `#797129` | 4.9 : 1 | AA          | AAA        |
+
+| ![#d91e18](https://via.placeholder.com/20/d91e18/d91e18.png) | `#d91e18` | 5.0 : 1 | AA | AAA |
+
+| ![#008000](https://via.placeholder.com/20/008000/008000.png) | `#008000` | 5.1 : 1 | AA | AAA |
+
+| ![#007faa](https://via.placeholder.com/20/007faa/007faa.png) | `#007faa` | 4.5 : 1 | AA | AAA |
+
+| ![#7928a1](https://via.placeholder.com/20/7928a1/7928a1.png) | `#7928a1` | 7.9 : 1 | AAA | AAA |
+
+| ![#545454](https://via.placeholder.com/20/545454/545454.png) | `#545454` | 7.5 : 1 | AAA | AAA |
diff --git a/a11y_pygments/a11y_high_contrast_light/images/a11y-high-contrast-light.png b/a11y_pygments/a11y_high_contrast_light/images/a11y-high-contrast-light.png
diff --git a/a11y_pygments/a11y_light/README.md b/a11y_pygments/a11y_light/README.md
@@ -1,8 +1,8 @@
-# A11y light
+# A11Y Light
 
-This is the pygments implementation of [`a11y light`](https://github.com/ericwbailey/a11y-syntax-highlighting) with high contrast.
+This style mimics the a11 light theme from eric bailey's accessible themes.
 
-![Screenshot of the light accessibility theme in a bash script](./images/a11y-light.png)
+![Screenshot of the a11y-light theme in a bash script](./images/a11y-light.png)
 
 ## Colors
 
@@ -12,12 +12,18 @@ Highlight color: ![#7971292e](https://via.placeholder.com/20/7971292e/7971292e.p
 
 **WCAG compliance**
 
-| Color                                                        | Hex       | Ratio    | Normal text | Large text |
-| ------------------------------------------------------------ | --------- | -------- | ----------- | ---------- |
-| ![#696969](https://via.placeholder.com/20/696969/696969.png) | `#696969` | 5.44 : 1 | AA          | AAA        |
-| ![#d91e18](https://via.placeholder.com/20/d91e18/d91e18.png) | `#d91e18` | 5.02 : 1 | AA          | AAA        |
-| ![#aa5d00](https://via.placeholder.com/20/aa5d00/aa5d00.png) | `#aa5d00` | 4.87 : 1 | AA          | AAA        |
-| ![#008000](https://via.placeholder.com/20/008000/008000.png) | `#008000` | 5.09 : 1 | AA          | AAA        |
-| ![#007faa](https://via.placeholder.com/20/007faa/007faa.png) | `#007faa` | 4.51 : 1 | AA          | AAA        |
-| ![#7928a1](https://via.placeholder.com/20/7928a1/7928a1.png) | `#7928a1` | 7.91 : 1 | AAA         | AAA        |
-| ![#545454](https://via.placeholder.com/20/545454/545454.png) | `#545454` | 7.51 : 1 | AAA         | AAA        |
+| Color                                                        | Hex       | Ratio   | Normal text | Large text |
+| ------------------------------------------------------------ | --------- | ------- | ----------- | ---------- |
+| ![#696969](https://via.placeholder.com/20/696969/696969.png) | `#696969` | 5.4 : 1 | AA          | AAA        |
+
+| ![#d91e18](https://via.placeholder.com/20/d91e18/d91e18.png) | `#d91e18` | 5.0 : 1 | AA | AAA |
+
+| ![#aa5d00](https://via.placeholder.com/20/aa5d00/aa5d00.png) | `#aa5d00` | 4.9 : 1 | AA | AAA |
+
+| ![#008000](https://via.placeholder.com/20/008000/008000.png) | `#008000` | 5.1 : 1 | AA | AAA |
+
+| ![#007faa](https://via.placeholder.com/20/007faa/007faa.png) | `#007faa` | 4.5 : 1 | AA | AAA |
+
+| ![#7928a1](https://via.placeholder.com/20/7928a1/7928a1.png) | `#7928a1` | 7.9 : 1 | AAA | AAA |
+
+| ![#545454](https://via.placeholder.com/20/545454/545454.png) | `#545454` | 7.5 : 1 | AAA | AAA |
diff --git a/a11y_pygments/a11y_light/images/a11y-light.png b/a11y_pygments/a11y_light/images/a11y-light.png
diff --git a/a11y_pygments/blinds_dark/README.md b/a11y_pygments/blinds_dark/README.md
@@ -1,8 +1,8 @@
-# Blinds dark
+# Blinds Dark
 
-This is the pygments implementation of [`blinds dark`](https://github.com/orbulant/blinds-theme).
+This style mimics the blinds dark theme from vscode themes.
 
-![Screenshot of the dark accessibility theme in a bash script](./images/blinds-dark.png)
+![Screenshot of the blinds-dark theme in a bash script](./images/blinds-dark.png)
 
 ## Colors
 
@@ -15,9 +15,15 @@ Highlight color: ![#66666691](https://via.placeholder.com/20/66666691/66666691.p
 | Color                                                        | Hex       | Ratio   | Normal text | Large text |
 | ------------------------------------------------------------ | --------- | ------- | ----------- | ---------- |
 | ![#8C8C8C](https://via.placeholder.com/20/8C8C8C/8C8C8C.png) | `#8C8C8C` | 4.6 : 1 | AA          | AAA        |
-| ![#ee6677](https://via.placeholder.com/20/ee6677/ee6677.png) | `#ee6677` | 5 : 1   | AA          | AAA        |
-| ![#ccbb44](https://via.placeholder.com/20/ccbb44/ccbb44.png) | `#ccbb44` | 8.1 : 1 | AAA         | AAA        |
-| ![#66ccee](https://via.placeholder.com/20/66ccee/66ccee.png) | `#66ccee` | 8.5 : 1 | AAA         | AAA        |
-| ![#5391CF](https://via.placeholder.com/20/5391CF/5391CF.png) | `#5391CF` | 4.7 : 1 | AA          | AAA        |
-| ![#D166A3](https://via.placeholder.com/20/D166A3/D166A3.png) | `#D166A3` | 4.5 : 1 | AA          | AAA        |
-| ![#bbbbbb](https://via.placeholder.com/20/bbbbbb/bbbbbb.png) | `#bbbbbb` | 8.1 : 1 | AAA         | AAA        |
+
+| ![#ee6677](https://via.placeholder.com/20/ee6677/ee6677.png) | `#ee6677` | 5.0 : 1 | AA | AAA |
+
+| ![#ccbb44](https://via.placeholder.com/20/ccbb44/ccbb44.png) | `#ccbb44` | 8.0 : 1 | AAA | AAA |
+
+| ![#66ccee](https://via.placeholder.com/20/66ccee/66ccee.png) | `#66ccee` | 8.5 : 1 | AAA | AAA |
+
+| ![#5391CF](https://via.placeholder.com/20/5391CF/5391CF.png) | `#5391CF` | 4.7 : 1 | AA | AAA |
+
+| ![#D166A3](https://via.placeholder.com/20/D166A3/D166A3.png) | `#D166A3` | 4.5 : 1 | AA | AAA |
+
+| ![#bbbbbb](https://via.placeholder.com/20/bbbbbb/bbbbbb.png) | `#bbbbbb` | 8.1 : 1 | AAA | AAA |
diff --git a/a11y_pygments/blinds_dark/images/blinds-dark.png b/a11y_pygments/blinds_dark/images/blinds-dark.png