🚚 Update installation script

Author: drearondov

README.md

@@ -19,14 +19,18 @@
 [![Latest release](https://img.shields.io/github/v/release/drearondov/pygments-rose-pine?style=for-the-badge)](https://github.com/drearondov/pygments-rose-pine/releases/latest)
 [![Any color you like](https://img.shields.io/badge/code%20style-black-black?style=for-the-badge)](https://github.com/psf/black)
 
+## Requirements
+
+This package has been tested on Python versions 3.9, 3.10, 3.11 with Python 3.9 beeing the minimum required.
+
 ## Installation
 
 The `pygments-rose-pine` package is not currently published to [PyPI](https://pypi.org/).
 If, however, you still wish to install this package, the following steps
 *should* work to install the [latest release](https://github.com/drearondov/pygments-rose-pine/releases/latest).
 
 ```bash
-repo="https://github.com/drearondov/pygments-rose-pine"
+repo="git@github.com:rose-pine/pygments.git"
 
 # Find the latest release.
 latest=$(git ls-remote --tags --refs $repo | # Fetch remote tags.
@@ -84,6 +88,14 @@ options(radian.color_scheme = "rose-pine")
 
 ## Gallery
 
+*Rose Piné*
+
 ![Rosé Pine](docs/static/rose-pine.png)
+
+*Rose Piné Moon*
+
 ![Rosé Pine Moon](docs/static/rose-pine-moon.png)
+
+*Rose Piné Dawn*
+
 ![Rosé Pine Dawn](docs/static/rose-pine-dawn.png)

docs/code-of-conduct.rst

@@ -88,4 +88,4 @@ at `<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>`_.
 
 Community Impact Guidelines were inspired by `Mozilla's code of conduct enforcement ladder <https://github.com/mozilla/diversity>`_.
 
-For answers to common questions about this code of conduct, see the FAQ at `<https://www.contributor-covenant.org/faq>`_. Translations are available at `<https://www.contributor-covenant.org/translations>`_.
+For answers to common questions about this code of conduct, see the FAQ at `<https://www.contributor-covenant.org/faq>`_. Translations are available at `<https://www.contributor-covenant.org/translations>.

docs/index.rst

@@ -30,7 +30,7 @@ release <https://github.com/drearondov/pygments-rose-pine/releases/latest>`__.
 
 .. code:: bash
 
-   repo="https://github.com/drearondov/pygments-rose-pine"
+   repo="https://github.com/rose-pine/pygments.git"
 
    # Find the latest release.
    latest=$(git ls-remote --tags --refs $repo | # Fetch remote tags.
@@ -111,7 +111,7 @@ Gallery
    :width: 45%
 
 .. image:: static/rose-pine-dawn.png
-   :width: 45%
+   :width: 40%
 
 
 .. |Python versions| image:: https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fdrearondov%2Fpygments-rose-pine%2Fmain%2Fpyproject.toml&style=for-the-badge&logo=python&logoColor=white&color=blue

poetry.lock

@@ -44,6 +44,7 @@ coverage = "^7.3.2"
 ipython = "^8.16.1"
 sphinx-autodoc-typehints = "^1.24.0"
 furo = "^2023.9.10"
+flake8-docstrings = "^1.7.0"
 
 [tool.poetry.plugins."pygments.styles"]
 "rose-pine" = "rosepine:RosePineStyle"

pyproject.toml

@@ -1,3 +1,4 @@
+"""Rose Piné for Pygments."""
 __author__: str = "Andrea Rondón"
 __email__: str = "[email protected]"
 __version__: str = "1.0.0"

src/__init__.py

@@ -27,9 +27,7 @@
 
 @dataclass(frozen=True)
 class Color:
-    """
-    Absolute colors as defined by rose-pine: https://rosepinetheme.com/palette
-    """
+    """Absolute colors as defined by rose-pine: https://rosepinetheme.com/palette."""
 
     pine_base = "#191724"
     pine_surface = "#1f1d2e"
@@ -49,7 +47,7 @@ class Color:
 
 
 class RosePineStyle(Style):
-    """Soho vibes for Pygments. Based on the colors of Rose Pine main theme"""
+    """Soho vibes for Pygments. Based on the colors of Rose Pine main theme."""
 
     styles: Dict[Any, str] = {
         Comment: Color.pine_subtle,

src/rosepine.py

@@ -27,9 +27,7 @@
 
 @dataclass(frozen=True)
 class Color:
-    """
-    Absolute colors as defined by rose-pine: https://rosepinetheme.com/palette
-    """
+    """Absolute colors as defined by rose-pine: https://rosepinetheme.com/palette."""
 
     dawn_base = "#faf4ed"
     dawn_surface = "#fffaf3"
@@ -49,7 +47,7 @@ class Color:
 
 
 class RosePineDawnStyle(Style):
-    """Soho vibes for Pygments. Based on the colors of Rose Pine Dawn theme"""
+    """Soho vibes for Pygments. Based on the colors of Rose Pine Dawn theme."""
 
     styles: Dict[Any, str] = {
         Comment: Color.dawn_subtle,

src/rosepinedawn.py

@@ -27,9 +27,7 @@
 
 @dataclass(frozen=True)
 class Color:
-    """
-    Absolute colors as defined by rose-pine: https://rosepinetheme.com/palette
-    """
+    """Absolute colors as defined by rose-pine: https://rosepinetheme.com/palette."""
 
     moon_base = "#232136"
     moon_surface = "#2a273f"
@@ -49,7 +47,7 @@ class Color:
 
 
 class RosePineMoonStyle(Style):
-    """Soho vibes for Pygments. Based on the colors of Rose Pine Moon theme"""
+    """Soho vibes for Pygments. Based on the colors of Rose Pine Moon theme."""
 
     styles: Dict[Any, str] = {
         Comment: Color.moon_subtle,

src/rosepinemoon.py

@@ -35,18 +35,17 @@ deps =
     flake8-commas ~= 2.0.0
     flake8-docstrings ~= 1.5.0
     pep8-naming ~= 0.9.0
-    mypy ~= 0.760
 commands_pre =
 commands =
-    black --check rosepine.py
-    flake8 --docstring-convention=google rosepine.py
+    black --check src
+    flake8 --docstring-convention=google src
     mypy \
         --disallow-untyped-calls \
         --disallow-untyped-defs \
         --disallow-incomplete-defs \
         --disallow-untyped-decorators \
         rosepine.py
-    bandit --recursive -ll rosepine.py
+    bandit --recursive -ll src
 
 [testenv:docs]
 basepython = python3.11