Merge pull request #34 from alan-turing-institute/fix-build

Fix build

.github/workflows/pythonapp.yml

@@ -67,7 +67,7 @@ jobs:
       if: matrix.depsize == 'full' 
       shell: bash
       run: |
-        pip install .[all,tests]
+        pip install .[extras,tests]
 
     - name: Install minimal dependencies
       if: matrix.depsize == 'minimal' 

.readthedocs.yaml

@@ -0,0 +1,25 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python 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
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

README.md

@@ -39,19 +39,21 @@ colours (e.g. with `distinctipy.color_swatch`) or examples you will need `matplo
 with the optional flag:
 
 ```bash
-python -m pip install distinctipy[optional]
+python -m pip install distinctipy[extras]
 ```
 
+⚠️ Warning ⚠️ Previous versions of distinctipy (before 1.3) used `[optional]` instead of `[extras]`.
+
 Or install them separately:
 
 ```bash
 python -m pip install matplotlib pandas
 ```
 
-For developers, to install the stack needed to run tests, generate docs etc. use the `[all]` flag:
+For developers, to install the stack needed to run tests, generate docs etc. use:
 
 ```bash
-python -m pip install distinctipy[all]
+python -m pip install distinctipy[extras,tests,docs]
 ```
 
 ## Usage and Examples

distinctipy/__init__.py

@@ -9,10 +9,10 @@
     [(0, 1, 0), (1, 0, 1), (0, 0.5, 1), (1, 0.5, 0), (0.5, 0.75, 0.5)]
 """
 # flake8: noqa
+from importlib.metadata import version
 
 name = "distinctipy"
-
-__version__ = "1.3.1"
+__version__ = version(__name__)
 
 # Expose these module names and their internals in the top-level API
 __external__ = ["distinctipy"]

pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "distinctipy"
+version = "1.3.2"
+authors = [
+    {name = "Jack Roberts", email = "jroberts@turing.ac.uk"},
+]
+description = "A lightweight package for generating visually distinct colours."
+readme = "README.md"
+requires-python = ">=3.7"
+keywords = ["color", "colour", "palette", "colormap", "colorblind", "colourblind"]
+license = {file = "LICENSE"}
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Multimedia :: Graphics",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Topic :: Utilities",
+    "Framework :: Matplotlib",
+]
+dependencies = ["numpy>=1.16.3"]
+
+[project.optional-dependencies]
+extras = [
+    "pandas>=0.24.2",
+    "matplotlib>=3.1.0",
+
+]
+tests = [
+    "black==22.6.0",
+    "codecov>=2.0.15",
+    "coverage>=5.3.1",
+    "flake8==4.0.1",
+    "isort==5.10.1",
+    "pytest>=4.6.0",
+    "pytest-cov>=2.9.0",
+]
+docs = [
+    "sphinx-rtd-theme>=0.2.3",
+    "nbsphinx>=0.8.0",
+    "ipython>=7.34.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/alan-turing-institute/distinctipy"
+Documentation = "https://distinctipy.readthedocs.io/"