fix #297 - correct the invocation in version_from_scm

Author: RonnyPfannschmidt

CHANGELOG.rst

@@ -1,3 +1,8 @@
+v3.1.0
+=======
+
+* fix #297 - correct the invocation in version_from_scm and deprecate it as its exposed by accident
+
 v3.0.6
 ======
 * fix #295 - correctly handle selfinstall from tarballs

src/setuptools_scm/__init__.py

@@ -24,8 +24,14 @@
 
 
 def version_from_scm(root):
+    warnings.warn(
+        "version_from_scm is deprecated please use get_version",
+        category=DeprecationWarning,
+    )
+    config = Configuration()
+    config.root = root
     # TODO: Is it API?
-    return _version_from_entrypoint(root, "setuptools_scm.parse_scm")
+    return _version_from_entrypoint(config, "setuptools_scm.parse_scm")
 
 
 def _call_entrypoint_fn(config, fn):

testing/test_basic_api.py

@@ -46,6 +46,11 @@ def test_root_parameter_creation(monkeypatch):
     setuptools_scm.get_version()
 
 
+def test_version_from_scm(wd):
+    with pytest.warns(DeprecationWarning, match=".*version_from_scm.*"):
+        setuptools_scm.version_from_scm(str(wd))
+
+
 def test_root_parameter_pass_by(monkeypatch, tmpdir):
     assert_root(monkeypatch, tmpdir)
     setuptools_scm.get_version(root=tmpdir.strpath)