You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Various README improvements + version 1.0.1 bump for pypi readme
- added screenshot of code completion and docs in pycharm
- changed relative links to absolute URLs to fix PyPi file links
- python2 and python3 pip instructions
Copy file name to clipboardExpand all lines: README.md
+13-2Lines changed: 13 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,8 @@ as well as for use in projects developed at [Privex Inc.](https://github.com/Pri
11
11
12
12
# License
13
13
14
-
**Python Log Helper** was created by [Privex Inc. of Belize City](https://www.privex.io), and licensed under the MIT License. See the file [LICENSE](LICENSE) for the license text.
14
+
**Python Log Helper** was created by [Privex Inc. of Belize City](https://www.privex.io), and licensed under the MIT License.
15
+
See the file [LICENSE](https://github.com/Privex/python-loghelper/blob/master/LICENSE) for the license text.
15
16
16
17
**TL;DR; license:**
17
18
@@ -36,10 +37,18 @@ Please make sure any changes you make meet these basic requirements:
36
37
37
38
### Download and install from PyPi using pip
38
39
40
+
**Python 3**
41
+
39
42
```sh
40
43
pip3 install privex-loghelper
41
44
```
42
45
46
+
**Python 2**
47
+
48
+
```sh
49
+
pip install privex-loghelper
50
+
```
51
+
43
52
### (Alternative) Manual install from Git
44
53
45
54
**Option 1 - Use pip to install straight from Github**
@@ -66,11 +75,13 @@ python3 setup.py install
66
75
67
76
# Usage
68
77
69
-
The code is very well documented, you can find out all usage documentation in [LogHelper.py](privex/loghelper/LogHelper.py).
78
+
The code is very well documented, you can find out all usage documentation in [LogHelper.py](https://github.com/Privex/python-loghelper/blob/master/privex/loghelper/LogHelper.py).
70
79
71
80
All functions are type annotated, with detailed pydoc block comments. If you're using a Python optimised IDE such as [PyCharm](https://www.jetbrains.com/pycharm/) it should
72
81
offer code completion and help when using the package.
73
82
83
+
84
+
74
85
### Basic usage
75
86
76
87
The most basic usage is to simply initialise the class with no parameters, and attach a
0 commit comments