check links

Author: kic

pandas-ml-utils-torch/Readme.md

@@ -9,7 +9,7 @@ advantages:
  * allows to implement auto-encoders easily by just providing the encode/decode functions
  * added loss functions like `SoftDTW` (fit time series) loss or `HeteroscedasticityLoss` (fit Normal Distribution) -> [example][ghl3]
 
-<br><br>
+<br/><br/>
 
 ![Fitting Example][ghi1]
 

pandas-ml-utils-torch/noxfile.py

@@ -11,6 +11,8 @@
 
 @nox.session(python=["3.8"], reuse_venv=False, venv_params=['--system-site-packages'])
 def tests(session):
+    dist_file = f"/tmp/pandas-ml-utils-torch-{__version__}.zip"
+
     # install testing requirements and local dependencies
     session.install("-r", "dev-requirements.txt")
     session.install("-r", "requirements.txt")
@@ -22,7 +24,7 @@ def tests(session):
 
     # create distribution and install
     session.run("python", "setup.py", "sdist",  "-d", "/tmp/", "--formats=zip", env={})
-    session.install(f"/tmp/pandas-ml-utils-torch-{__version__}.zip", "--no-deps")
+    session.install(dist_file, "--no-deps")
 
     # create notebook kernels
     kernel = "ml_utils_torch"
@@ -43,3 +45,6 @@ def tests(session):
 
     # clean up egg info
     shutil.rmtree("pandas_ml_utils_torch.egg-info")
+
+    # make link check
+    session.run("python", "pandas_ml_utils_torch_test/check_links.py", dist_file)

pandas-ml-utils-torch/pandas_ml_utils_torch_test/check_links.py

@@ -0,0 +1,8 @@
+import sys
+
+from pandas_ml_common_test.link_checker import check_links_in_dist
+
+
+if __name__ == "__main__":
+    _, dist = sys.argv
+    check_links_in_dist(dist, 'Readme.md')

pandas-ml-utils-torch/setup.py

@@ -1,35 +1,68 @@
 """Augment pandas DataFrame with methods for machine learning"""
 __version__ = '0.2.1'
-
 import os
+import re
+
 from setuptools import setup, find_packages
+from setuptools.command.sdist import sdist
+
+URL = 'https://github.com/KIC/pandas-ml-quant'
+NAME = 'pandas-ml-utils-torch'
+
+
+class SDist(sdist):
+
+    def fix_github_links(self, lines):
+        #   ist  https://github.com/KIC/pandas-ml-quant/pandas-ml-common/tree/0.2.0/./examples/
+        #   soll https://github.com/KIC/pandas-ml-quant/tree/0.2.0/pandas-ml-common/./examples/
+        def fix_line(line):
+            fixed_images = re.sub(r'(^\[ghi\d+]:\s+)', f'\\1{URL}/raw/{__version__}/{NAME}/', line)
+            fixed_location = re.sub(r'(^\[ghl\d+]:\s+)', f'\\1{URL}/tree/{__version__}/{NAME}/', fixed_images)
+            fixed_files = re.sub(r'(^\[ghf\d+]:\s+)', f'\\1{URL}/blob/{__version__}/{NAME}/', fixed_location)
+            return fixed_files
+
+        return [fix_line(line) for line in lines]
+
+    def make_release_tree(self, base_dir, files):
+        # create the regular distribution files
+        super().make_release_tree(base_dir, files)
+
+        # but then fix the github links
+        readme_file = os.path.join(base_dir, 'Readme.md')
+        readme_lines = open(readme_file).readlines()
+
+        with open(readme_file, 'w') as f:
+            f.writelines(self.fix_github_links(readme_lines))
 
 
 setup(
-   name="pandas-ml-utils-torch",
-   version=__version__,
-   author='KIC',
-   author_email='',
-   packages=find_packages(),
-   scripts=[],
-   url='https://github.com/KIC/pandas-ml-quant',
-   license='MIT',
-   description=__doc__,
-   long_description=open('Readme.md').read(),
-   long_description_content_type='text/markdown',
-   install_requires=open("requirements.txt").read().splitlines() + [f"pandas-ml-common=={__version__}", f"pandas-ml-utils=={__version__}"],
-   extras_require={
-      "dev": open("dev-requirements.txt").read().splitlines(),
-   },
-   include_package_data=True,
-   classifiers=[
-      # Chose either "3 - Alpha", "4 - Beta" or "5 - Production/Stable" as the current state of your package
-      'Development Status :: 3 - Alpha',
-      'Intended Audience :: Developers',
-      'Topic :: Software Development :: Build Tools',
-      'License :: OSI Approved :: MIT License',
-      'Programming Language :: Python :: 3',
-      'Programming Language :: Python :: 3.7',
-   ],
-   keywords=['pandas', 'ml', 'util', 'quant'],
+    name=NAME,
+    version=__version__,
+    author='KIC',
+    author_email='',
+    packages=find_packages(),
+    scripts=[],
+    url=f'{URL}/{NAME}',
+    license='MIT',
+    description=__doc__,
+    long_description=open('Readme.md').read(),
+    long_description_content_type='text/markdown',
+    install_requires=open("requirements.txt").read().splitlines() + [f"pandas-ml-common=={__version__}", f"pandas-ml-utils=={__version__}"],
+    extras_require={
+       "dev": open("dev-requirements.txt").read().splitlines(),
+    },
+    include_package_data=True,
+    classifiers=[
+        # Chose either "3 - Alpha", "4 - Beta" or "5 - Production/Stable" as the current state of your package
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Build Tools',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.8',
+    ],
+    keywords=['pandas', 'ml', 'util', 'quant'],
+    cmdclass={
+        'sdist': SDist
+    },
 )