Clarify that we do not support python 3.7 (#512)

* Update setup.py

* Readme: no python 3.7

* specify 3.6 in venv

* clarify 3.7 error

we will support it eventually
This commit is contained in:
Charlotte Weaver
2018-12-13 15:15:56 -08:00
committed by GitHub
parent 83154577e4
commit 46ad346df1
2 changed files with 29 additions and 13 deletions
+4 -2
View File
@@ -8,7 +8,9 @@
## getting started ## getting started
You'll need **python 3.6** and **Google Chrome**. The web UI is tested on OSX and Windows using Chrome, and the python CLI is tested on OSX and Ubuntu (via WSL/Windows). It should work on other platforms, but if you run into trouble let us know (see [help](#help-and-contact) below). You'll need **python 3.6** and **Google Chrome**. (*Warning*: Python 3.7 is **not** supported at this time)
The web UI is tested on OSX and Windows using Chrome, and the python CLI is tested on OSX and Ubuntu (via WSL/Windows). It should work on other platforms, but if you run into trouble let us know (see [help](#help-and-contact) below).
To install run To install run
@@ -109,7 +111,7 @@ Or you can create a virtual environment by using
``` ```
ENV_NAME=cellxgene ENV_NAME=cellxgene
python3 -m venv ${ENV_NAME} python3.6 -m venv ${ENV_NAME}
source ${ENV_NAME}/bin/activate source ${ENV_NAME}/bin/activate
pip install cellxgene pip install cellxgene
``` ```
+25 -11
View File
@@ -1,4 +1,13 @@
from setuptools import setup, find_packages from setuptools import setup, find_packages
import sys
if sys.version_info[0:2] != (3, 6):
raise ImportError(
"cellxgene currently only supports python 3.6. Python 3.7 is known to fail; we will look at supporting "
"versions other than 3.6 in the future."
"See https://github.com/chanzuckerberg/cellxgene#conda-and-virtual-environments "
"for more help with installation."
)
with open("README.md", "rb") as fh: with open("README.md", "rb") as fh:
long_description = fh.read().decode() long_description = fh.read().decode()
@@ -16,19 +25,24 @@ setup(
author_email="cweaver@chanzuckerberg.com", author_email="cweaver@chanzuckerberg.com",
description="Web application for exploration of large scale scRNA-seq datasets", description="Web application for exploration of large scale scRNA-seq datasets",
long_description=long_description, long_description=long_description,
long_description_content_type='text/markdown', long_description_content_type="text/markdown",
install_requires=requirements, install_requires=requirements,
include_package_data=True, include_package_data=True,
zip_safe=False, zip_safe=False,
classifiers=( classifiers=[
"Programming Language :: Python :: 3", "Framework :: Flask",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: MIT License", "License :: OSI Approved :: MIT License",
), "Natural Language :: English",
entry_points={ "Operating System :: POSIX",
"console_scripts": "Operating System :: Unix",
["cellxgene = server.cli.cli:cli"] "Operating System :: MacOS :: MacOS X",
}, "Programming Language :: JavaScript",
extras_require=dict( "Programming Language :: Python :: 3",
louvain=['python-igraph', 'louvain>=0.6'], "Programming Language :: Python :: 3.6",
), "Programming Language :: Python :: 3 :: Only",
"Topic :: Scientific/Engineering :: Bio-Informatics",
],
entry_points={"console_scripts": ["cellxgene = server.cli.cli:cli"]},
extras_require=dict(louvain=["python-igraph", "louvain>=0.6"]),
) )