Skip to content

Commit ebbb816

Browse files
committed
Add minimal setup.py
1 parent 5fb67c2 commit ebbb816

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

setup.py

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
"""This is a setup module for installing this project. To install the project,
2+
set the current working directory to the project root, and run:
3+
4+
``pip install .``
5+
6+
Depending on your environment, you may need some modifiers. To install for the
7+
current user only, run:
8+
9+
``pip install . --user``
10+
11+
``pip`` is sometimes aliased to the Python 3 version of pip, and sometimes to
12+
the Python 2 version. If you want to be sure to use the one for Python 3, run:
13+
14+
``python3 -m pip install . --user``
15+
16+
If you also want to be able to develop and run the test suite, you need to install
17+
with test dependencies (preferably in a virtual environment):
18+
19+
``pip install --editable .[TEST]``
20+
"""
21+
from setuptools import setup, find_packages
22+
23+
with open("README.md", mode="r") as file:
24+
README = file.read()
25+
26+
TEST_REQUIREMENTS = ["pytest>=4.0.0", "pytest-cov", "pytest-timeout"]
27+
REQUIRED = ["numpy", "matplotlib", "sympy", "scikit-learn", "tensorflow"]
28+
29+
setup(
30+
name="TheAlgorithms",
31+
description="All algorithms implemented in Python (for education)",
32+
long_description=README,
33+
long_description_content_type="text/markdown",
34+
license="MIT",
35+
packages=find_packages(exclude=("tests", "docs")),
36+
tests_require=TEST_REQUIREMENTS,
37+
install_requires=REQUIRED,
38+
extras_require=dict(TEST=TEST_REQUIREMENTS),
39+
python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*",
40+
)

0 commit comments

Comments
 (0)