Release 4.0.4 (#165)

* Documentation Build Fix (#164)

* Added readthedocs config yaml file

* Updated broken paths in docs

* fix: requirements.txt to reduce vulnerabilities (#163)

The following vulnerabilities are fixed by pinning transitive dependencies:
- https://snyk.io/vuln/SNYK-PYTHON-TORNADO-5537286

* - Update version and history

---------

Co-authored-by: lrjball <50599110+lrjball@users.noreply.github.com>
Co-authored-by: Snyk bot <github+bot@snyk.io>

.readthedocs.yaml

@@ -0,0 +1,43 @@
+# Read the Docs configuration file for Sphinx projects
+
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+
+# Required
+
+version: 2
+
+
+# Set the OS, Python version and other tools you might need
+
+build:
+
+  os: ubuntu-22.04
+
+  tools:
+
+    python: "3.11"
+
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+   - pdf
+   - epub
+
+
+# Optional but recommended, declare the Python requirements required
+
+# to build your documentation
+
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+
+python:
+
+   install:
+
+   - requirements: requirements_dev.txt

HISTORY.rst

@@ -2,6 +2,12 @@
 History
 =======
 
+4.0.4 (2023-08-23)
+------------------
+
+* Documentation build fix
+* Pin tornado requirement to reduce vulnerability
+
 4.0.3 (2023-04-21)
 ------------------
 

README.rst

@@ -77,4 +77,4 @@ This project adheres to the `Open Code of Conduct <https://github.com/spotify/co
 Contributing
 ------------
 
-`See the contributing docs <CONTRIBUTING.rst>`_.
+`See the contributing docs <https://github.com/spotify/chartify/blob/master/CONTRIBUTING.rst>`_.

chartify/__init__.py

@@ -23,7 +23,7 @@
 
 __author__ = """Chris Halpert"""
 __email__ = "chalpert@spotify.com"
-__version__ = "4.0.3"
+__version__ = "4.0.4"
 
 _IPYTHON_INSTANCE = False
 

docs/installation.rst

@@ -32,13 +32,13 @@ You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git://github.com/cphalpert/chartify
+    $ git clone git://github.com/spotify/chartify
 
 Or download the `tarball`_:
 
 .. code-block:: console
 
-    $ curl  -OL https://github.com/cphalpert/chartify/tarball/master
+    $ curl  -OL https://github.com/spotify/chartify/tarball/master
 
 Once you have a copy of the source, you can install it with:
 
@@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
     $ python setup.py install
 
 
-.. _Github repo: https://github.com/cphalpert/chartify
-.. _tarball: https://github.com/cphalpert/chartify/tarball/master
+.. _Github repo: https://github.com/spotify/chartify
+.. _tarball: https://github.com/spotify/chartify/tarball/master

requirements.txt

@@ -10,3 +10,4 @@ ipython>=7.17.0
 pyyaml>=6.0.0
 Jinja2>=3.1.0
 jupyter-bokeh>=3.0.7
+tornado>=6.3.2 # not directly required, pinned by Snyk to avoid a vulnerability