Skip to content

Commit 134fea5

Browse files
Push v1.0.3
1 parent 313f22f commit 134fea5

File tree

4 files changed

+37
-11
lines changed

4 files changed

+37
-11
lines changed

setup.py

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,22 @@
22
import codecs
33
import os
44

5-
VERSION = '1.0.2'
5+
VERSION = '1.0.3'
66
DESCRIPTION = 'A collection of assorted methods to make small tasks easier..'
77
LONG_DESCRIPTION = """
8-
# usefulib v1.0.2
9-
A useful library for Python with assorted functions to make small tasks easier.
8+
<div align="center">
9+
<img src="https://github.com/hamdivazim/usefulib/raw/main/logo.png">
10+
</div>
11+
<a style="display:inline;" href="#"><img src="https://img.shields.io/badge/Python- >= 2.7 -blue?style=plastic.svg" alt="python versions" /></a>
12+
<a style="display:inline;" href="#"><img src="https://badge.fury.io/py/usefulib.svg" alt="pypi version" /></a>
13+
<a style="display:inline;" href="#"><img src="https://img.shields.io/badge/first timer-friendly-4DC71F?style=plastic.svg" alt="first timer friendly" /></a>
14+
<a style="display:inline;" href="https://github.com/hamdivazim/usefulib/labels/usefulib-idea"><img src="https://img.shields.io/github/issues-raw/hamdivazim/usefulib/usefulib-idea?color=4DC71F&label=usefulib%20ideas" alt="usefulib ideas" /></a>
15+
<a style="display:inline;" href="#"><img src="https://img.shields.io/badge/tests- all passing -4DC71F?style=plastic.svg" alt="usefulib ideas" /></a>
16+
17+
18+
19+
<h1>usefulib v1.0.2</h1>
20+
A useful library for Python with <em>a lot</em> of assorted functions to make numerous small tasks easier.
1021
1122
### GitHub Page: https://github.com/hamdivazim/usefulib
1223
@@ -15,6 +26,10 @@
1526
```
1627
$ pip install usefulib
1728
```
29+
Alternatively, you can use the git URL to do the same.
30+
```
31+
$ pip install "git+https://github.com/hamdivazim/usefulib.git@pip-install#egg=usefulib"
32+
```
1833
1934
## How to use
2035
All you need to do is import the package, and all usefulibs that you may want will come along with it! As an example:
@@ -24,19 +39,30 @@
2439
a_string = "abcdef123456"
2540
reverse_string = usefulib.reverse_string(a_string)
2641
```
42+
If all you need is one usefulib:
43+
```python
44+
from usefulib import reverse_string
45+
46+
a_string = "abcdef123456"
47+
reverse_string = reverse_string(a_string)
48+
```
2749
2850
## What can it do?
29-
usefulib is open-source and can be contributed to by anyone. Therefore, it offers a lot of simple functions to make writing code easier and quicker. A complete list of all fuctions usefulib provides can be found [here](https://github.com/hamdivazim/usefulib/blob/main/ALLFUNCTIONS.md).
51+
As an open-source library and can be contributed to by anyone, it offers a lot of simple functions to make writing code easier and quicker. A complete list of all usefulibs that are available can be found [here](https://github.com/hamdivazim/usefulib/blob/main/ALLFUNCTIONS.md).
52+
53+
## Support usefulib
54+
usefulib is full of contributions from the community! We're beginner-friendly here, so read the [contributing guidelines](https://github.com/hamdivazim/usefulib/blob/main/CONTRIBUTING.md) and give us your best usefulibs 😃!
55+
56+
## License
57+
usefulib is licensed under the [GNU General Public License v3.0](https://github.com/hamdivazim/usefulib/blob/main/LICENSE).
3058
31-
## Can I contribute?
32-
Want to contribute? You rock! Before you do, make sure to read the [contributing guidelines](https://github.com/hamdivazim/usefulib/blob/main/CONTRIBUTING.md) and you should have your PR merged!
3359
"""
3460

3561
# Setting up
3662
setup(
3763
name="usefulib",
3864
version=VERSION,
39-
author="Hamdi Vazim",
65+
author="Hamd Waseem",
4066
author_email="<[email protected]>",
4167
description=DESCRIPTION,
4268
long_description_content_type="text/markdown",

usefulib/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
"""
2-
usefulib v1.0.2
2+
usefulib v1.0.3
33
Copyright Hamd Waseem (https://github.com/hamdivazim) under the GNU Public License 3.0.
44
55
https://github.com/hamdivazim/usefulib
66
"""
77

8-
__version__ = "1.0.2"
8+
__version__ = "1.0.3"
99

1010
from ._usefulibs import *

usefulib/_usefulibs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
usefulib v1.0.2
2+
usefulib v1.0.3
33
Copyright Hamd Waseem (https://github.com/hamdivazim) under the GNU Public License 3.0.
44
55
https://github.com/hamdivazim/usefulib

usefulib/tests.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
usefulib v1.0.2
2+
usefulib v1.0.3
33
Copyright Hamd Waseem (https://github.com/hamdivazim) under the GNU Public License 3.0.
44
55
https://github.com/hamdivazim/usefulib

0 commit comments

Comments
 (0)