0.5

Varios fixes for pypi and easy usage
Z3R0-CDS · Sep 12, 2023 · cf10192 · cf10192
1 parent 74f55f3
commit cf10192
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ Version: 0.4
 ## Navigation
 - <a href="\docs\installation.md">Installation</a>
 - <a href="\docs\changelog.md">Changelogs</a>
-- <a href="\docs\migration.md">Migrating to 0.4</a>
+- <a href="\docs\migration.md">Migrating to 0.5</a>
 
 ## Disclaimer
     I do not promise to maintain this project or to update it frequently!

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -3,8 +3,10 @@
 !!!NOT DOCUMENTED UNTIL 0.3.4!!!<br>
 For more infos follow commits
 ```
-0.4.1
-   Fixed issues with pypi
+0.5
+    [+] Pypi releases fixed
+    [+] Urllib3 bugs resolved
+    [+] Resolved bugs with version controll
 
 0.4
    [+] Package now automatic on pypi

diff --git a/docs/installation.md b/docs/installation.md
@@ -1,20 +1,24 @@
 ## Installation
 
 ### Recommended <a href="https://pypi.org/project/nfc-uid/">PIP</a> METHOD
-!!!!!!! Currently I am not really able to use github actions as I want to !!!!!!!!
-0.4.x is currently "broken" in pypi please wait with install until I fixed that... Sorry
 
 ```
 pip install nfc_uid
 ```
-Usage: import nfc_uid
+Usage
+```
+from nfc_uid import nfc_uid
+```
+
 
 #### REPO METHOD / Local usage
 - Clone this repo
 - Run these commands
 ```
 pip install keyboard
 pip install pysscard
+pip install requests
+pip install urllib3==1.26.15
 ```
 
 Usage: python main.py or import main as nfc_uid
diff --git a/docs/migration.md b/docs/migration.md
@@ -1,6 +1,6 @@
 ## Migration
 
-### Migrating to 0.4.x
+### Migrating to 0.5.x
 For Version 0.4 I did a bit of reworking to improve the performance and apply new things I learned over time.<br>
 One Major change is the implementation of object oriented coding.<br>
 While working on that I also improved the reader function.<br>
@@ -13,18 +13,18 @@ In Case you do not use custom arguments/parameters just follow the example down
 
 Example:<br>
 
-    Pre 0.4
+    Pre 0.5
     ---------------
     from nfc_uid import *
 
     nfc_hwid = nfc_reader()
     ---------------
 
-    0.4
+    0.5
     ---------------
-    from nfc_uid import NFC_UID
+    from nfc_uid import nfc_uid
 
-    nfc_uid = NFC_UID()
+    nfc_uid = nfc_uid.NFC_UID()
 
     nfc_hwid = nfc_uid.read()
 
diff --git a/nfc_uid/main.py → nfc_uid/nfc_uid.py b/nfc_uid/main.py → nfc_uid/nfc_uid.py
@@ -12,6 +12,7 @@
     import requests
 except ImportError:
     os.system('python -m pip install requests')
+    os.system('python -m pip install urllib3==1.26.15')
 try:
     import keyboard as Keyboard
 except ImportError:
@@ -28,9 +29,9 @@
     os._exit(1)
 
 class NFC_UID:
-    __version = "0.4"
+    __version = "0.5"
     __name="nfc-uid"
-    pypi_version=None
+    pypi_version="0.5"
     logging = True
     last_chip = ""
     loop = True

diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = nfc_uid
-version = 0.4.5
+version = 0.5
 description = Get UUID of NFC card with a scanner.
 long_description = file: README.md
 long_description_content_type = text/markdown