Skip to content

Added setup file #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,4 @@ __pycache__/
pre_commit.ps1
htmlcov
*coverage*
# for developement purposes
pds_debug.py
*.egg-info/
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,23 @@ How are we different?

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.

Installation
------------

You can install the library by running the following command,

```python
python3 setup.py install
```

For development purposes you can use the option `develop` as shown below,

```python
python3 setup.py develop
```

Make sure that your python version is above `3.5`.

Why we use Python?
-----------------

Expand Down Expand Up @@ -52,4 +69,12 @@ Please follow the rules and guidelines given below,
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.
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`.

The following parameters are to be followed to pass the code quality tests for your,
Pull Requests,

1. There should not be any trailing white spaces at any line of code.
2. Each `.py` file should end with exactly one new line.
3. Comparisons involving `True`, `False` and `None` should be done by
reference(using `is`, `is not`) and not by value(`==`, `!=`).

Keep contributing!!
26 changes: 26 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import setuptools

with open("README.md", "r") as fh:
long_description = fh.read()

setuptools.setup(
name="pydatastructs",
version="0.0.0",
author="PyDataStructs Development Team",
author_email="pydatastructs@googlegroups.com",
description="A python package for data structures",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/codezonediitj/pydatastructs",
packages=setuptools.find_packages(),
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Topic :: Education :: Data Structures",
"Topic :: Scientific/Engineering",
"Topic :: Scientific/Engineering :: Information Analysis",
"Topic :: Software Development :: Libraries"
],
python_requires='>=3.5',
)