update README + increase attempts for downloading

README.md

@@ -2,7 +2,7 @@
 <img src="./docs/_static/logo.png">
 </div>
 
-![unit-tests](https://github.com/AlexanderVNikitin/tsgm/actions/workflows/test.yml/badge.svg?event=push)
+![unit-tests](https://github.com/AlexanderVNikitin/tsgm/actions?query=workflow%3ATests+branch%3Amain)
 [![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/release/python-380/)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/AlexanderVNikitin/tsgm/blob/main/LICENSE)
 
@@ -107,5 +107,16 @@ TSGM provides a number of time series augmentations.
 ## Contributing
 We appreciate all contributions. To learn more, please check [CONTRIBUTING.md](CONTRIBUTING.md).
 
+## Citing
+If you find this repo useful, please consider citing our paper:
+```
+@article{
+    nikitin2023gen,
+    author = {Alexander Nikitin and Samuel Kaski},
+    title = {TSGM --- A Flexible Framework for Synthetic Time Series Generative Modeling},
+    year = {2023},
+}
+```
+
 ## License
 [Apache License 2.0](LICENSE)

setup.py

@@ -35,6 +35,14 @@
 ]
 
 
+def read_file(filename: str) -> str:
+    with open(filename, encoding="utf-8") as f:
+        return f.read().strip()
+
+
+readme_text = read_file("README.md")
+
+
 setup(name='tsgm',
       version='0.0.1',
       description='Time Series Generative Modelling Framework',
@@ -45,7 +53,7 @@
       url=url,
       download_url='',
       keywords=keywords,
-      long_description="",
+      long_description=readme_text,
       license=license,
       entry_points={
         "console_scripts": ["tsgm-gd=cli.gd:main", "tsgm-eval=cli.eval:main"],

tsgm/utils/file_utils.py

@@ -44,7 +44,7 @@ def extract_archive(from_path: str, to_path: typing.Optional[str] = None, pwd: t
     os.remove(from_path)
 
 
-def download(url: str, path: str, md5: typing.Optional[str] = None, max_attempt: int = 2) -> None:
+def download(url: str, path: str, md5: typing.Optional[str] = None, max_attempt: int = 3) -> None:
     logger.info(f"### Downloading from {url} ###")
     os.makedirs(path, exist_ok=True)
     resource_name = url.split("/")[-1]