|
2 | 2 | import codecs
|
3 | 3 | import os
|
4 | 4 |
|
5 |
| -VERSION = '1.0.2' |
| 5 | +VERSION = '1.0.3' |
6 | 6 | DESCRIPTION = 'A collection of assorted methods to make small tasks easier..'
|
7 | 7 | 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. |
10 | 21 |
|
11 | 22 | ### GitHub Page: https://github.com/hamdivazim/usefulib
|
12 | 23 |
|
|
15 | 26 | ```
|
16 | 27 | $ pip install usefulib
|
17 | 28 | ```
|
| 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 | +``` |
18 | 33 |
|
19 | 34 | ## How to use
|
20 | 35 | 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 | 39 | a_string = "abcdef123456"
|
25 | 40 | reverse_string = usefulib.reverse_string(a_string)
|
26 | 41 | ```
|
| 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 | +``` |
27 | 49 |
|
28 | 50 | ## 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). |
30 | 58 |
|
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! |
33 | 59 | """
|
34 | 60 |
|
35 | 61 | # Setting up
|
36 | 62 | setup(
|
37 | 63 | name="usefulib",
|
38 | 64 | version=VERSION,
|
39 |
| - author="Hamdi Vazim", |
| 65 | + author="Hamd Waseem", |
40 | 66 | author_email="<[email protected]>",
|
41 | 67 | description=DESCRIPTION,
|
42 | 68 | long_description_content_type="text/markdown",
|
|
0 commit comments