Skip to content

Commit d754853

Browse files
authored
Added setup file (#75)
* added setup.py file * updated README.md
1 parent 15a1dbb commit d754853

File tree

3 files changed

+52
-2
lines changed

3 files changed

+52
-2
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,4 @@ __pycache__/
99
pre_commit.ps1
1010
htmlcov
1111
*coverage*
12-
# for developement purposes
13-
pds_debug.py
12+
*.egg-info/

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,23 @@ How are we different?
1313

1414
There are many pre-exisiting packages available in the open source world based on the above idea. However, they lack the implementation of complex data structures and this makes us different. If you have worked with C++ and Python then you know how hard it is to code bug free AVL trees :-).Well, after this project you will not have to worry about it. In fact, we will keep each data structure independent from each other for easy code reusability.
1515

16+
Installation
17+
------------
18+
19+
You can install the library by running the following command,
20+
21+
```python
22+
python3 setup.py install
23+
```
24+
25+
For development purposes you can use the option `develop` as shown below,
26+
27+
```python
28+
python3 setup.py develop
29+
```
30+
31+
Make sure that your python version is above `3.5`.
32+
1633
Why we use Python?
1734
-----------------
1835

@@ -52,4 +69,12 @@ Please follow the rules and guidelines given below,
5269
2. If you are planning to contribute a new data structure then first raise an issue for discussing the API, rather than directly making a PR.
5370
3. For the first-time contributors we recommend not to take a complex data strucutre, rather start with `linear data structures` or `abstract data types`. You can also pick issues labelled as `good_first_issues`.
5471

72+
The following parameters are to be followed to pass the code quality tests for your,
73+
Pull Requests,
74+
75+
1. There should not be any trailing white spaces at any line of code.
76+
2. Each `.py` file should end with exactly one new line.
77+
3. Comparisons involving `True`, `False` and `None` should be done by
78+
reference(using `is`, `is not`) and not by value(`==`, `!=`).
79+
5580
Keep contributing!!

setup.py

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import setuptools
2+
3+
with open("README.md", "r") as fh:
4+
long_description = fh.read()
5+
6+
setuptools.setup(
7+
name="pydatastructs",
8+
version="0.0.0",
9+
author="PyDataStructs Development Team",
10+
author_email="[email protected]",
11+
description="A python package for data structures",
12+
long_description=long_description,
13+
long_description_content_type="text/markdown",
14+
url="https://github.com/codezonediitj/pydatastructs",
15+
packages=setuptools.find_packages(),
16+
classifiers=[
17+
"Programming Language :: Python :: 3",
18+
"License :: OSI Approved :: BSD License",
19+
"Operating System :: OS Independent",
20+
"Topic :: Education :: Data Structures",
21+
"Topic :: Scientific/Engineering",
22+
"Topic :: Scientific/Engineering :: Information Analysis",
23+
"Topic :: Software Development :: Libraries"
24+
],
25+
python_requires='>=3.5',
26+
)

0 commit comments

Comments
 (0)