From 69ed6602f9a85a9147388c061a17b6d2439a95f9 Mon Sep 17 00:00:00 2001 From: iamDyeus Date: Tue, 22 Oct 2024 21:08:43 +0530 Subject: [PATCH] refactor: improve long description handling in setup.py & images in `README.md` --- README.MD | 6 +++--- setup.py | 12 ++++++++---- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/README.MD b/README.MD index 16ddb02..a1fe46d 100644 --- a/README.MD +++ b/README.MD @@ -29,10 +29,10 @@ Let’s assume that a developer restarts their terminal application approximatel tkreload solves this issue by providing an automatic reload mechanism for terminal-based Python applications, particularly those using Tkinter. It eliminates the need for manual restarts, saving developers hours of time and streamlining the debugging process. ## Without tkreload -![Without tkreload](./.assets/without.gif) +![Without tkreload](https://github.com/iamDyeus/tkreload/blob/main/.assets/without.gif?raw=true) ## With tkreload -![With tkreload](./.assets/with.gif) +![With tkreload](https://github.com/iamDyeus/tkreload/blob/main/.assets/with.gif?raw=true) # Getting Started @@ -94,7 +94,7 @@ Contributions are welcome and greatly appreciated! Here's how you can contribute 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request -![COMMUNISM](./.assets/communism.png) +![COMMUNISM](https://github.com/iamDyeus/tkreload/blob/main/.assets/communism.png?raw=true) # License diff --git a/setup.py b/setup.py index 698ff2f..c08cd4c 100644 --- a/setup.py +++ b/setup.py @@ -1,15 +1,19 @@ from setuptools import setup, find_packages -import pathlib +# import pathlib # Get the long description from the README file -here = pathlib.Path(__file__).parent.resolve() -long_description = (here / 'README.md').read_text(encoding='utf-8') +# here = pathlib.Path(__file__).parent.resolve() +# long_description = (here / 'README.md').read_text(encoding='utf-8') + +def readme(): + with open('README.md') as f: + return f.read() setup( name='tkreload', version='1.0.0', description='A library that auto reloads your tkinter app whenever file changes are detected.', - long_description=long_description, + long_description=readme(), long_description_content_type='text/markdown', author='iamDyeus', author_email='dyeusyt@gmail.com',