Skip to content

Commit

Permalink
Python 3.6: Enabled library to be installed on 3.6, after performing …
Browse files Browse the repository at this point in the history
…manual tests inside the docker container and on Google Colab
  • Loading branch information
neomatrix369 committed Sep 16, 2020
1 parent fc368b4 commit 4f117a6
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 7 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Changelog

Changelog for nlp_profiler.

## 0.0.1
### GitHub branch `test-python-3.6-compatibility` enable support for Python 3.6

Based on the issue raised on github #1

[e5c7a11](https://github.com/neomatrix369/nlp_profiler/commit/e5c7a11) Mani Sarkar _Wed Sep 16 17:15:29 2020 +0100_
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ _**Note:** this is a new endeavour and it's may have rough edges i.e. probably N

## Requirements

- Python 3.7.x or higher
- Python 3.6.x or higher
- Dependencies described in the `requirements.txt`
- (Optional)
- Jupyter Lab (on your local machine)
Expand Down Expand Up @@ -65,6 +65,8 @@ See [Notebooks](#Notebooks) section for further illustrations.

## Notebooks

_Once the library is successfully installed, please RESTART your Jupyter kernels or Google Colab runtimes for the changes to take effect._

### Jupyter

See [Jupyter Notebook](./notebooks/jupyter/nlp_profiler.ipynb)
Expand Down
2 changes: 1 addition & 1 deletion notebooks/google-colab/nlp_profiler-granular.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"%%bash\n",
"\n",
"pip install git+https://github.com/neomatrix369/nlp_profiler.git@master\n",
"echo \"Once successfully installed, please restart your Jupyter kernels for the changes to take effect\""
"echo \"Once successfully installed, please RESTART your Jupyter kernels or Colab runtimes for the changes to take effect\""
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion notebooks/google-colab/nlp_profiler.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"%%bash\n",
"\n",
"pip install git+https://github.com/neomatrix369/nlp_profiler.git@master\n",
"echo \"Once successfully installed, please restart your Jupyter kernels for the changes to take effect\""
"echo \"Once successfully installed, please RESTART your Jupyter kernels or Colab runtimes for the changes to take effect\""
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion notebooks/jupyter/nlp_profiler-granular.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"%%bash\n",
"\n",
"pip install git+https://github.com/neomatrix369/nlp_profiler.git@master\n",
"echo \"Once successfully installed, please restart your Jupyter kernels for the changes to take effect\""
"echo \"Once successfully installed, please RESTART your Jupyter kernels or Colab runtimes for the changes to take effect\""
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion notebooks/jupyter/nlp_profiler.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"%%bash\n",
"\n",
"pip install git+https://github.com/neomatrix369/nlp_profiler.git@master\n",
"echo \"Once successfully installed, please restart your Jupyter kernels for the changes to take effect\""
"echo \"Once successfully installed, please RESTART your Jupyter kernels or Colab runtimes for the changes to take effect\""
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,14 @@
include_package_data=True,
keywords="nlpprofiler, nlpprof, nlp_profiler, nlp-profiler",
install_requires=install_requirements,
python_requires=">=3.7.0",
python_requires=">=3.6.0",
classifiers=[
"Development Status :: 2 - Pre-Alpha",
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache 2.0 License",
"Natural Language :: English",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
],
Expand Down
3 changes: 2 additions & 1 deletion tests/smoke-tests/run-python-in-docker.sh
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
#!/bin/bash
set -eou pipefail

PYTHON_VERSION=${1:-"3.7"}
PYTHON_VERSION=${1:-"3.6"}

MOUNT_VOLUME="${PWD}/../../"
TARGET_FOLDER="/nlp_profiler"
echo "~~~ Running Python ${PYTHON_VERSION} in a docker container"
echo "Mounted volume: ${MOUNT_VOLUME}"
echo "Manual smoke test steps: "
echo " $ pip install pandas"
echo " $ python setup.py install"
echo " $ python"
echo " >>> import nlp_profiler.core as nlpprof"
echo " ( Use the steps in the Jupyter notebook: notebooks/jupyter/nlp_profiler.ipynb )"
Expand Down

0 comments on commit 4f117a6

Please sign in to comment.