add ruff

Author: alinelena

README.md

@@ -7,5 +7,3 @@ It is a simple helper for cases when one needs to download data in systems like
 
   from data import get_data
   get_data(url="https://raw.githubusercontent.com/ddmms/data-tutorials/main/data/LiFePO4_supercell.cif", filename="LiFePO4_supercell.cif", folder="data")
-
-

data_tutorials/data.py

@@ -1,29 +1,37 @@
-# -*- coding: utf-8 -*-
 # Author; alin m elena, alin@elena.re
 # Contribs;
 # Date: 26-07-2024
 # ©alin m elena, GPL v3 https://www.gnu.org/licenses/gpl-3.0.en.html
+"""
+Simple module to download a file from a URL and save it in a specific folder.
+"""
 
 from urllib.request import urlretrieve
 from pathlib import Path
+
 # this is only for python 3.9 once done use str| list[str]
 from typing import Union
 
-default_url = "https://raw.githubusercontent.com/ddmms/data-tutorials/main/data/"
-def download_file(url: str, filename:str, dest: Path) -> None:
-    save_file = dest/filename
+DEFAULT_URL = "https://raw.githubusercontent.com/ddmms/data-tutorials/main/data/"
+
+
+def download_file(url: str, filename: str, dest: Path) -> None:
+    save_file = dest / filename
     print(f"try to download {filename} from {url} and save it in {save_file}")
-    path, headers = urlretrieve(url+filename, save_file)
+    path, _ = urlretrieve(url + filename, save_file)
     if path.exists():
         print(f"saved in {save_file}")
     else:
         print(f"{save_file} could not be downloaded, check url.")
 
-def get_data(url: str=default_url, filename: Union[str, list[str]] = "", folder: str="data") -> None:
+
+def get_data(
+    url: str = DEFAULT_URL, filename: Union[str, list[str]] = "", folder: str = "data"
+) -> None:
     p = Path(folder)
     p.mkdir(parents=True, exist_ok=True)
-    if isinstance(filename,str):
-        download_file(url,filename,p)
+    if isinstance(filename, str):
+        download_file(url, filename, p)
     elif isinstance(filename, list):
         for f in filename:
-           download_file(url,f,p)
+            download_file(url, f, p)

pyproject.toml

@@ -8,7 +8,7 @@ name = "data-tutorials"
 dynamic = ["version"]
 dependencies = [
   "pytest",
-  "ruff", 
+  "ruff",
 ]
 requires-python = ">=3.9"
 authors = [
@@ -45,10 +45,8 @@ pythonpath = [
 ]
 
 [tool.ruff]
-line-length = 100
-indent-width = 2
+line-length = 88
 target-version = "py38"
-line-ending = "auto"
 
 [tool.ruff.lint]
 

release.sh

@@ -3,4 +3,4 @@
 version=$1
 
 git tag -f -a v$version -m "release $version"
-git push --tags 
+git push --tags

tests/test_file.py

@@ -1,33 +1,43 @@
-# -*- coding: utf-8 -*-
 # Author; alin m elena, alin@elena.re
 # Contribs;
 # Date: 26-07-2024
 # ©alin m elena, GPL v3 https://www.gnu.org/licenses/gpl-3.0.en.html
-import pytest
-from data_tutorials.data import get_data
-import hashlib
+
+"""
+Tests various downloads.
+"""
+
 from pathlib import Path
+import hashlib
+from data_tutorials.data import get_data
+
 
 def test_download_file():
-   get_data(filename="LiFePO4_supercell.cif",folder="data-test")
-   with open(Path("data-test")/"LiFePO4_supercell.cif", "rb") as fd:
-      try:
-        h  = hashlib.file_digest(fd, "sha256")
-      except AttributeError:
-        h  = hashlib.sha256()
-        h.update(fd.read())
-   assert h.hexdigest() == "ea9a538dde5bb84b92e9478dbcc078bb560b28a4f5e4b0469d416bff36be272e"
+    get_data(filename="LiFePO4_supercell.cif", folder="data-test")
+    with open(Path("data-test") / "LiFePO4_supercell.cif", "rb") as fd:
+        try:
+            h = hashlib.file_digest(fd, "sha256")
+        except AttributeError:
+            h = hashlib.sha256()
+            h.update(fd.read())
+    assert (
+        h.hexdigest()
+        == "ea9a538dde5bb84b92e9478dbcc078bb560b28a4f5e4b0469d416bff36be272e"
+    )
+
 
 def test_download_files():
-   files = ["LiFePO4_supercell.cif","h2o.xyz"]
-   sha256={'LiFePO4_supercell.cif':"ea9a538dde5bb84b92e9478dbcc078bb560b28a4f5e4b0469d416bff36be272e",
-           'h2o.xyz': "522ab1d36d213e48ab6e08517ec3f648c378d4b9efd257feadc64a1d8f3e66d6"}
-   get_data(filename=files,folder="data-test")
-   for f in files:
-      with open(Path("data-test")/f, "rb") as fd:
-         try:
-           h  = hashlib.file_digest(fd, "sha256")
-         except AttributeError:
-           h  = hashlib.sha256()
-           h.update(fd.read())
-      assert h.hexdigest() == sha256[f]
+    files = ["LiFePO4_supercell.cif", "h2o.xyz"]
+    sha256 = {
+        "LiFePO4_supercell.cif": "ea9a538dde5bb84b92e9478dbcc078bb560b28a4f5e4b0469d416bff36be272e",
+        "h2o.xyz": "522ab1d36d213e48ab6e08517ec3f648c378d4b9efd257feadc64a1d8f3e66d6",
+    }
+    get_data(filename=files, folder="data-test")
+    for f in files:
+        with open(Path("data-test") / f, "rb") as fd:
+            try:
+                h = hashlib.file_digest(fd, "sha256")
+            except AttributeError:
+                h = hashlib.sha256()
+                h.update(fd.read())
+        assert h.hexdigest() == sha256[f]

tox.ini

@@ -2,5 +2,5 @@
 envlist = py3
 
 [testenv]
-deps = pytest 
-commands = pytest 
+deps = pytest
+commands = pytest