Skip to content

Commit

Permalink
refactor: improve long description handling in setup.py & images in `…
Browse files Browse the repository at this point in the history
…README.md`
  • Loading branch information
iamDyeus committed Oct 22, 2024
1 parent 1d5dd7d commit 69ed660
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
12 changes: 8 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
@@ -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',
Expand Down

0 comments on commit 69ed660

Please sign in to comment.