Merge pull request #177 from MindSetLib/dev

Maintenance: versioning with setuptools_scm; Adding pip install insolver[dev]; GitHub Actions optimization.

.github/workflows/insolver-tests.yaml

@@ -21,11 +21,6 @@ jobs:
       uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
-    - name: macOS setup
-      if: matrix.os == 'macOS-latest'
-      shell: bash
-      run: |
-        brew install libomp
     - name: Install dependencies
       shell: bash
       run: |

.github/workflows/python-app.yml

@@ -21,11 +21,6 @@ jobs:
       uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
-    - name: macOS setup
-      if: matrix.os == 'macOS-latest'
-      shell: bash
-      run: |
-        brew install libomp
     - name: Install dependencies
       shell: bash
       run: |

README.md

@@ -12,9 +12,10 @@ Insolver is a low-code machine learning library, originally created for the insu
 
 ## Installation:
 
-```shell
-pip install insolver
-```
+- Insolver can be installed by running `pip install insolver`.
+- If you want to install insolver with all heavy requirements, install with `pip install insolver[full]`.
+- If you want to install insolver with development requirements, install with `pip install insolver[dev]`.
+
 
 ### Insolver is already installed in the easy access cloud via the GitHub login. Try https://mset.space with a familiar notebook-style environment.
 

docs/conf.py

@@ -1,33 +1,18 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
 import os
 import sys
 from datetime import datetime
+from importlib.metadata import version
 
 sys.path.insert(0, os.path.abspath('../insolver/'))
 
-
 # -- Project information -----------------------------------------------------
 
 project = 'Insolver'
 copyright = f'2020-{datetime.now().year}, MindSet Team'
 author = 'MindSet Team'
 
-# The full version, including alpha/beta/rc tags
-with open('../VERSION', "r", encoding="utf-8") as v:
-    v = v.read()
-
-release = version = v
+release = version('insolver')
+version = '.'.join(release.split('.')[:3])
 
 
 # -- General configuration ---------------------------------------------------

docs/source/installation.md

@@ -13,6 +13,6 @@ pip install "git+https://github.com/MindSetLib/Insolver.git"
 ## Install from PyPI
 Insolver can be installed via pip from [PyPI](https://pypi.org/project/insolver/).
 
-```shell
-pip install insolver
-```
+- Insolver can be installed by running `pip install insolver`.
+- If you want to install insolver with all heavy requirements, install with `pip install insolver[full]`.
+- If you want to install insolver with development requirements, install with `pip install insolver[dev]`.

pyproject.toml

@@ -1,9 +1,12 @@
 [build-system]
 requires = [
     "setuptools",
+    "setuptools_scm[toml]>=6.2",
     "wheel"
 ]
 
+[tool.setuptools_scm]
+
 [tool.black]
 line-length = 120
 skip-string-normalization = true

setup.py

@@ -4,25 +4,25 @@
 with open("requirements.txt") as f:
     required = f.read().splitlines()
 
-with open("requirements-extra.txt") as f:
-    extras = f.read().splitlines()
+with open("requirements-dev.txt") as f:
+    req_dev = f.read().splitlines()
 
+with open("./docs/requirements-docs.txt") as f:
+    req_dev += f.read().splitlines()
 
-with open('VERSION', "r", encoding="utf-8") as v:
-    version = v.read()
+with open("requirements-extra.txt") as f:
+    extras = f.read().splitlines()
 
 
 if __name__ == "__main__":
-    setup(version=version,
-          packages=find_packages(),
+    setup(packages=find_packages(),
           entry_points={
               'console_scripts': [
                   'insolver_serving = insolver.serving.run_service:run'
               ]
           },
           install_requires=required,
-          setup_requires=['setuptools', 'wheel'],
-          extras_require={'full': extras},
+          extras_require={'full': extras, 'dev': req_dev},
           zip_safe=False,
           python_requires='>=3.7',
           include_package_data=True