Use declarative setup.cfg; use setuptools_scm to set version

Author: ZedThree

.github/workflows/docs.yml

@@ -8,6 +8,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: ammaraskar/sphinx-action@master
         with:
+          pre-build-command: "pip install .[docs]"
           docs-folder: "docs/"
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3

.github/workflows/main.yml

@@ -22,7 +22,7 @@ jobs:
           architecture: x64
 
       - name: Setup
-        run: pip install -r test_requirements.txt
+        run: pip install .[tests]
 
       - name: Unittests
         run: pytest -v
@@ -41,7 +41,7 @@ jobs:
 
       - name: Coverage report
         run: |
-          pip install -r test_requirements.txt
+          pip install .[tests]
           pytest --cov=fortls --cov-report=xml
 
       - name: Upload coverage to Codecov

.github/workflows/python-publish.yml

@@ -40,37 +40,6 @@ jobs:
           python -m pip install --upgrade pip
           pip install build
 
-        # see: https://github.community/t/how-to-get-just-the-tag-name/16241/7
-      - name: Get the version
-        id: get_version
-        shell: bash
-        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
-
-      - name: Set global variables
-        shell: bash
-        run: |
-          echo "VERSION=${{ steps.get_version.outputs.VERSION }}" >> $GITHUB_ENV
-
-      - name: Set __version__
-        shell: bash
-        run: sed -i "s@\".*\"@\"${VERSION}\"@g" "fortls/_version.py"
-
-      # Disabled the workflow because it messes up with the Releases on GitHub
-      # releases that use tags through force-push are marked as drafts
-      # will have to manually update the versions in _version.py
-      # - name: Commit the new version to dev
-      #   shell: bash
-      #   run: |
-      #     git config --global user.name 'gnikit'
-      #     git config --global user.email '[email protected]'
-      #     git fetch origin
-      #     git switch dev
-      #     git commit -S fortls/_version.py -m "Auto-Update version" -v
-      #     git push
-      #     git tag -f "${VERSION}"
-      #     git push --delete origin "${VERSION}"
-      #     git push origin "${VERSION}"
-
       - name: Build package
         run: python -m build
 

.gitignore

@@ -4,6 +4,7 @@
 dist/
 docs/_build/
 docs/fortls_changes.md
+fortls/_version.py
 
 .idea
 

docs/conf.py

@@ -15,7 +15,7 @@
 
 sys.path.insert(0, os.path.abspath(".."))
 
-from fortls._version import __version__  # noqa: E402
+from fortls import __version__  # noqa: E402
 
 # Generate the agglomerated changes (from the CHANGELOG) between fortls
 # and the fortran-language-server project

fortls/__init__.py

@@ -6,13 +6,16 @@
 import sys
 from multiprocessing import freeze_support
 
-from ._version import __version__
 from .helper_functions import resolve_globs, only_dirs
 from .jsonrpc import JSONRPC2Connection, ReadWriter, path_from_uri
 from .langserver import LangServer
 from .parse_fortran import fortran_file, process_file
 from .interface import commandline_args
 
+from .version import __version__
+
+__all__ = ["__version__"]
+
 
 def error_exit(error_str: str):
     print(f"ERROR: {error_str}")

fortls/_version.py

@@ -4,7 +4,7 @@
 import json
 import sys
 
-from ._version import __version__
+from fortls.version import __version__
 
 
 class SetAction(argparse.Action):

fortls/interface.py

@@ -11,7 +11,7 @@
 from typing import Pattern
 
 # Local modules
-from fortls._version import __version__
+from fortls.version import __version__
 from fortls.constants import (
     CLASS_TYPE_ID,
     FORTRAN_LITERAL,

fortls/langserver.py

@@ -0,0 +1,10 @@
+try:
+    from importlib.metadata import version, PackageNotFoundError
+except ModuleNotFoundError:
+    from importlib_metadata import version, PackageNotFoundError
+try:
+    __version__ = version(__package__)
+except PackageNotFoundError:
+    from setuptools_scm import get_version
+
+    __version__ = get_version(root="..", relative_to=__file__)