Skip to content

Commit 872c62c

Browse files
Add setup.py
1 parent 086825e commit 872c62c

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

setup.py

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
from setuptools import setup, find_packages
2+
import codecs
3+
import os
4+
5+
VERSION = '1.0.0'
6+
DESCRIPTION = 'A collection of assorted methods to make small tasks easier..'
7+
LONG_DESCRIPTION = """
8+
# usefulib v1.0
9+
A useful library for Python with assorted functions to make small tasks easier.
10+
11+
## How to install
12+
Install with pip in your terminal, making sure Python is added to PATH:
13+
```
14+
$ pip install usefulib
15+
```
16+
17+
## How to use
18+
All you need to do is import the package, and all usefulibs that you may want will come along with it! As an example:
19+
```python
20+
import usefulib
21+
22+
a_string = "abcdef123456"
23+
reverse_string = usefulib.reverse_string(a_string)
24+
```
25+
26+
## What can it do?
27+
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).
28+
29+
## Can I contribute?
30+
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!
31+
"""
32+
33+
# Setting up
34+
setup(
35+
name="usefulibs",
36+
version=VERSION,
37+
author="Hamdi Vazim",
38+
author_email="<[email protected]>",
39+
description=DESCRIPTION,
40+
long_description_content_type="text/markdown",
41+
long_description=LONG_DESCRIPTION,
42+
packages=find_packages(),
43+
install_requires=[],
44+
keywords=['python', 'useful', 'usefulib', 'collection'],
45+
classifiers=[
46+
"Development Status :: 5 - Production/Stable",
47+
"Intended Audience :: Developers"
48+
"Programming Language :: Python :: 3",
49+
"Operating System :: Unix",
50+
"Operating System :: MacOS :: MacOS X",
51+
"Operating System :: Microsoft :: Windows",
52+
]
53+
)

0 commit comments

Comments
 (0)