diff --git a/README.md b/README.md index c64dd67..d456256 100644 --- a/README.md +++ b/README.md @@ -28,15 +28,19 @@ pip install -U prototorch ``` To also install the extras, use ```bash -pip install -U prototorch[datasets,examples,tests] +pip install -U prototorch[all] ``` +*Note: If you're using [ZSH](https://www.zsh.org/), the square brackets `[ ]` +have to be escaped like so: `\[\]`, making the install command `pip install -U +prototorch\[all\]`.* + To install the bleeding-edge features and improvements: ```bash git clone https://github.com/si-cim/prototorch.git git checkout dev cd prototorch -pip install -e . +pip install -e .[all] ``` ## Documentation diff --git a/setup.py b/setup.py index 9e4c2f4..a16692a 100644 --- a/setup.py +++ b/setup.py @@ -3,48 +3,68 @@ from setuptools import setup from setuptools import find_packages -PROJECT_URL = 'https://github.com/si-cim/prototorch' -DOWNLOAD_URL = 'https://github.com/si-cim/prototorch.git' +PROJECT_URL = "https://github.com/si-cim/prototorch" +DOWNLOAD_URL = "https://github.com/si-cim/prototorch.git" -with open('README.md', 'r') as fh: +with open("README.md", "r") as fh: long_description = fh.read() -setup(name='prototorch', - version='0.1.1-rc0', - description='Highly extensible, GPU-supported ' - 'Learning Vector Quantization (LVQ) toolbox ' - 'built using PyTorch and its nn API.', +INSTALL_REQUIRES = [ + "torch>=1.3.1", + "torchvision>=0.5.0", + "numpy>=1.9.1", +] +DOCS = [ + "recommonmark", + "sphinx", + "sphinx_rtd_theme", + "sphinxcontrib-katex", +] +DATASETS = [ + "requests", + "tqdm", +] +EXAMPLES = [ + "sklearn", + "matplotlib", +] +TESTS = ["pytest"] +ALL = DOCS + DATASETS + EXAMPLES + TESTS + +setup(name="prototorch", + version="0.1.1-rc0", + description="Highly extensible, GPU-supported " + "Learning Vector Quantization (LVQ) toolbox " + "built using PyTorch and its nn API.", long_description=long_description, - long_description_content_type='text/markdown', - author='Jensun Ravichandran', - author_email='jjensun@gmail.com', + long_description_content_type="text/markdown", + author="Jensun Ravichandran", + author_email="jjensun@gmail.com", url=PROJECT_URL, download_url=DOWNLOAD_URL, - license='MIT', - install_requires=[ - 'torch>=1.3.1', - 'torchvision>=0.5.0', - 'numpy>=1.9.1', - ], + license="MIT", + install_requires=INSTALL_REQUIRES, extras_require={ - 'datasets': ['requests', 'tqdm'], - 'examples': [ - 'sklearn', - 'matplotlib', - ], - 'tests': ['pytest'], + "docs": DOCS, + "datasets": DATASETS, + "examples": EXAMPLES, + "tests": TESTS, + "all": ALL, }, classifiers=[ - 'Development Status :: 2 - Pre-Alpha', 'Environment :: Console', - 'Intended Audience :: Developers', 'Intended Audience :: Education', - 'Intended Audience :: Science/Research', - 'License :: OSI Approved :: MIT License', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Operating System :: OS Independent', - 'Topic :: Scientific/Engineering :: Artificial Intelligence', - 'Topic :: Software Development :: Libraries', - 'Topic :: Software Development :: Libraries :: Python Modules' + "Development Status :: 2 - Pre-Alpha", + "Environment :: Console", + "Intended Audience :: Developers", + "Intended Audience :: Education", + "Intended Audience :: Science/Research", + "License :: OSI Approved :: MIT License", + "Natural Language :: English", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Operating System :: OS Independent", + "Topic :: Scientific/Engineering :: Artificial Intelligence", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Libraries :: Python Modules", ], packages=find_packages())