diff --git a/.gitignore b/.gitignore index 63d172d54..917ba6634 100644 --- a/.gitignore +++ b/.gitignore @@ -9,5 +9,4 @@ __pycache__/ pre_commit.ps1 htmlcov *coverage* -# for developement purposes -pds_debug.py +*.egg-info/ diff --git a/README.md b/README.md index 18247a83f..efa2646ee 100644 --- a/README.md +++ b/README.md @@ -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? ----------------- @@ -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!! diff --git a/setup.py b/setup.py new file mode 100644 index 000000000..0bac5f40c --- /dev/null +++ b/setup.py @@ -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', +)