1.0.0

Author: Kadir Aksoy

.gitignore

@@ -1,2 +1,5 @@
 __pycache__/
 dev/
+dist/
+olddist/
+pyqt5Custom.egg-info/

README.md

@@ -2,14 +2,11 @@
 <p>
   <img src="https://img.shields.io/badge/python-3.6%2B-green">
   <img src="https://img.shields.io/badge/license-GPL%203.0-blue.svg">
-  <img src="https://img.shields.io/badge/version-0.0.4-orange">
+  <img src="https://img.shields.io/badge/version-1.0.0-orange">
 </p>
-More useful and stylish widgets for PyQt5 such as toggle switches, animated buttons, etc.. 
+More useful and stylish widgets for PyQt5 such as toggle switches, animated buttons, etc..
 <br>
-<img src="https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/data/showcase.gif" width="500"> 
-
-**DISCLAIMER:** \
-Currently most widgets can't use style sheets properly so you have to use attributes to stylize them. I'm working on removing this inconvenience and make their usage as close as to base Qt widgets
+<img src="https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/data/showcase.gif" width="500">
 
 ## Table of Contents
 - [Installing](#Installing)
@@ -22,8 +19,15 @@ Currently most widgets can't use style sheets properly so you have to use attrib
 - [License](#License)
 
 ## Installing
-The module (version 0.0.4) is not on PyPi yet, so you have to manually download `pyqt5Custom` folder. Version 0.0.5 will be on PyPi. \
-You can also use PySide2 instead of PyQt5 with just litte changes.
+Install using PIP (it might be `pip3` or `python3` depending on your platform)
+```
+pip install pyqt5Custom
+```
+or
+```
+python -m pip install pyqt5Custom
+```
+Also you can also use PySide2 instead of PyQt5 with just litte changes.
 
 ## Usage
 Just import `pyqt5Custom` and you're ready to go. You can check out [Examples](https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/), one little example for ToggleSwitch widget:
@@ -45,6 +49,7 @@ layout.addWidget(togglesw)
 | ![ImageBox](https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/data/imagebox.png) <br> **ImageBox** <br> [Documentation](documentation.md) | ![ColorPicker](https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/data/colorpicker.png) <br> **ColorPicker** <br> [Documentation](documentation.md) |
 | ![DragDropFile](https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/data/dropfileshowcase.gif) <br> **DragDropFile** <br> [Documentation](documentation.md) | ![EmbedWindow](https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/data/embedwindowshowcase.gif) <br> **EmbedWindow** <br> [Documentation](documentation.md) |
 | ![CodeTextEdit](https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/data/codetextshowcase.gif) <br> **CodeTextEdit** <br> [Documentation](documentation.md) | ![TitleBar](https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/data/titlebarshowcase.png) <br> **TitleBar** <br> [Documentation](documentation.md) |
+| ![Spinner](https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/data/spinnershowcase.gif) <br> **Spinner** <br> [Documentation](documentation.md) | ![Toast](https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/data/toastshowcase.gif) <br> **Toast** <br> [Documentation](documentation.md) |
 
 
 ## Dependencies

documentation.md

@@ -9,8 +9,17 @@ Here is the list of currently implemented widgets
 - [EmbedWindow](#DEmbedWindow)
 - [CodeTextEdit](#CodeTextEdit)
 - [TitleBar](#TitleBar)
-- [Misc](#misc)
+- [Spinner](#Spinner)
+- [Toast](#Toast)
 
+## Other stuff
+Other stuff that the the library provides but are not mainly widgets. Some are tools, data classes, etc...
+- [RequestHandler](#RequestHandler)
+- [FileDetails](#FileDetails)
+- [Animation](#Animation)
+- [AnimationHandler](#AnimationHandler)
+- [ColorPreview](#ColorPreview)
+- [SyntaxHighlighter](#SyntaxHighlighter)
 
 
 ## ToggleSwitch
@@ -121,13 +130,21 @@ Here is the list of currently implemented widgets
 - `title()` (str) : Get title
 
 
-# Misc
-Other stuff _(which you mostly don't need to know they existed)_ included within the module other than custom widgets
-- [FileDetails](#FileDetails)
-- [ColorPreview](#ColorPreview)
-- [SyntaxHighlighter](#SyntaxHighlighter)
-- [Animation](#Animation)
-- [AnimationHandler](#AnimationHandler)
+# Other stuff
+Other stuff that the the library provides but are not mainly widgets. Some are tools, data classes, etc...
+
+## RequestHandler
+`RequestHandler` is a thread (QThread) that can be used to handle HTTP requests while avoiding blocking Qt's event loop. You can see [Examples](https://github.com/kadir014/pyqt5-custom-widgets/blob/main/examples/) to see usage of this class.
+
+#### Methods
+- `newRequest(method, url, headers, data)`
+  - `method` (str) : Request method
+  - `url` (str) : Address where request will be sent at
+  - `headers` (dict) : Request headers
+  - `data` (dict) : Request data
+
+#### Signals
+- `requestResponded` : Emitted when a requeest in the current pool gets responded. Response is a [requests.Response](https://docs.python-requests.org/en/latest/api/#requests.Response) object
 
 ## FileDetails
 `FileDetails` object is a data class which is meant to be used by `DragDropFile` for `fileDropped` signal
@@ -139,14 +156,14 @@ Other stuff _(which you mostly don't need to know they existed)_ included within
 - `pureName` (str) : File's name without the extension
 - `extension` (str) : File's extension
 
-## ColorPreview
-`ColorPreview` is a widget to display some color. It can bee seen used next to ColorPicker example. But this widget is most likely going to be deprecated
-
-## SyntaxHighlighter
-`SyntaxHighlighter` inherits `QSyntaxHighlighter`, it's only purpose is to serve `CodeTextEdit` widget. `pyqt5Custom` module currently (version 0.0.4) supports only Python and C++ syntax highlighting.
-
 ## Animation
 `Animation` is just a static class holding easing animation functions. This class is most likely going to be deprecated when I rework animations.
 
 ## AnimationHandler
 `AnimationHandler` animates widget's properties using `Animation` class's functions. This class is most likely going to be deprecated when I rework animations.
+
+## ColorPreview
+`ColorPreview` is a widget to display some color. It can bee seen used next to ColorPicker example. But this widget is most likely going to be deprecated
+
+## SyntaxHighlighter
+`SyntaxHighlighter` inherits `QSyntaxHighlighter`, it's only purpose is to serve `CodeTextEdit` widget. `pyqt5Custom` module currently supports only Python and C++ syntax highlighting.