From cf101921463ffbae9e094e76938f052c5e04a4cd Mon Sep 17 00:00:00 2001
From: Zero Codes <78277955+Z3R0-CDS@users.noreply.github.com>
Date: Tue, 12 Sep 2023 17:39:35 +0200
Subject: [PATCH] 0.5
Varios fixes for pypi and easy usage
---
README.md | 2 +-
docs/changelog.md | 6 ++++--
docs/installation.md | 10 +++++++---
docs/migration.md | 10 +++++-----
nfc_uid/{main.py => nfc_uid.py} | 5 +++--
setup.cfg | 2 +-
6 files changed, 21 insertions(+), 14 deletions(-)
rename nfc_uid/{main.py => nfc_uid.py} (98%)
diff --git a/README.md b/README.md
index 0fbc816..85233c8 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ Version: 0.4
## Navigation
- Installation
- Changelogs
-- Migrating to 0.4
+- Migrating to 0.5
## Disclaimer
I do not promise to maintain this project or to update it frequently!
diff --git a/docs/changelog.md b/docs/changelog.md
index f536989..055945a 100644
--- a/docs/changelog.md
+++ b/docs/changelog.md
@@ -3,8 +3,10 @@
!!!NOT DOCUMENTED UNTIL 0.3.4!!!
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
index 855b425..f5af7fb 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -1,13 +1,15 @@
## Installation
### Recommended PIP 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
@@ -15,6 +17,8 @@ Usage: import nfc_uid
```
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
index 84d33eb..7f9217f 100644
--- 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.
One Major change is the implementation of object oriented coding.
While working on that I also improved the reader function.
@@ -13,18 +13,18 @@ In Case you do not use custom arguments/parameters just follow the example down
Example:
- 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 b/nfc_uid/nfc_uid.py
similarity index 98%
rename from nfc_uid/main.py
rename to nfc_uid/nfc_uid.py
index 6f87594..acd5da7 100644
--- a/nfc_uid/main.py
+++ b/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
index 0f38e02..108e690 100644
--- 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