Yuxuan/dependency issue (#275)

* remove en_core_web_sm from dependencies, update 'import_nltk.py' to 'download_resources.py' that automatically download resources if not found

* update test workflow

* fix test workflow

* update documentation

* build docs

---------

Co-authored-by: sundy1994 <[email protected]>

Author: xehu

.gitignore

@@ -52,3 +52,7 @@ examples/vector_data/*
 examples/output/*
 node_modules/
 
+# testing
+/output
+/vector_data
+test.py

README.md

@@ -23,18 +23,18 @@ To use our tool, please ensure that you have Python >= 3.10 installed and a work
 pip install team_comm_tools
 ```
 
-You will also need to ensure that Spacy and NLTK are installed in addition to the required dependencies. The Spacy model should download `en_core_web_sm` automatically upon install. If you get an error that en_core_web_sm is not found, you should run the following in your terminal:
+This command will automatically install our package and all required dependencies.
 
-```sh
-spacy download en_core_web_sm
-```
+## Troubleshooting
 
-Additionally, we require several NLTK dependencies. If you don't have them in your environment, run this one-liner in your terminal:
+In the event that some dependency installations fail (for example, you may get an error that `en_core_web_sm` from Spacy is not found, or that there is a missing NLTK resource), please run this simple one-line command in your terminal, which will force the installation of Spacy and NLTK dependencies:
 
 ```sh
-import_nltk
+download_resources
 ```
 
+If you encounter a further issue in which the 'wordnet' package from NLTK is not found, it may be related to a known bug in NLTK in which the wordnet package does not unzip automatically. If this is the case, please follow the instructions to manually unzip it, documented in [this thread](https://github.com/nltk/nltk/issues/3028).
+
 ## Import Recommendations: Virtual Environment and Pip
 
 **We strongly recommend using a virtual environment in Python to run the package.** We have several specific dependency requirements. One important one is that we are currently only compatible with numpy < 2.0.0 because [numpy 2.0.0 and above](https://numpy.org/devdocs/release/2.0.0-notes.html#changes) made significant changes that are not compatible with other dependencies of our package. As those dependencies are updated, we will support later versions of numpy.

docs/build/doctrees/environment.pickle

@@ -10,21 +10,22 @@ Getting Started
 
 To use our tool, please ensure that you have Python >= 3.10 installed and a working version of `pip <https://pypi.org/project/pip/>`_, which is Python's package installer. Then, in your local environment, run the following:
 
-.. code-block::
+.. code-block:: sh
 
    pip install team_comm_tools
 
-You will also need to ensure that Spacy and NLTK are installed in addition to the required dependencies. The Spacy model should download ``en_core_web_sm`` automatically upon install. If you get an error that en_core_web_sm is not found, you should run the following in your terminal:
+This command will automatically install our package and all required dependencies.
 
-.. code-block::
+Troubleshooting
+++++++++++++++++
 
-   spacy download en_core_web_sm
+In the event that some dependency installations fail (for example, you may get an error that ``en_core_web_sm`` from Spacy is not found, or that there is a missing NLTK resource), please run this simple one-line command in your terminal, which will force the installation of Spacy and NLTK dependencies:
 
-Additionally, we require several NLTK dependencies. If you don't have them in your environment, run this one-liner in your terminal:
+.. code-block:: sh
 
-.. code-block::
+   download_resources
 
-	import_nltk
+If you encounter a further issue in which the 'wordnet' package from NLTK is not found, it may be related to a known bug in NLTK in which the wordnet package does not unzip automatically. If this is the case, please follow the instructions to manually unzip it, documented in `this thread <https://github.com/nltk/nltk/issues/3028>`_.
 
 Import Recommendations: Virtual Environment and Pip
 +++++++++++++++++++++++++++++++++++++++++++++++++++++

docs/build/doctrees/examples.doctree

@@ -12,21 +12,22 @@ Getting Started
 
 To use our tool, please ensure that you have Python >= 3.10 installed and a working version of `pip <https://pypi.org/project/pip/>`_, which is Python's package installer. Then, in your local environment, run the following:
 
-.. code-block::
+.. code-block:: sh
 
    pip install team_comm_tools
 
-You will also need to ensure that Spacy and NLTK are installed in addition to the required dependencies. The Spacy model should download ``en_core_web_sm`` automatically upon install. If you get an error that en_core_web_sm is not found, you should run the following in your terminal:
+This command will automatically install our package and all required dependencies.
 
-.. code-block::
+Troubleshooting
+++++++++++++++++
 
-   spacy download en_core_web_sm
+In the event that some dependency installations fail (for example, you may get an error that ``en_core_web_sm`` from Spacy is not found, or that there is a missing NLTK resource), please run this simple one-line command in your terminal, which will force the installation of Spacy and NLTK dependencies:
 
-Additionally, we require several NLTK dependencies. If you don't have them in your environment, run this one-liner in your terminal:
+.. code-block:: sh
 
-.. code-block::
+   download_resources
 
-   import_nltk
+If you encounter a further issue in which the 'wordnet' package from NLTK is not found, it may be related to a known bug in NLTK in which the wordnet package does not unzip automatically. If this is the case, please follow the instructions to manually unzip it, documented in `this thread <https://github.com/nltk/nltk/issues/3028>`_.
 
 Import Recommendations: Virtual Environment and Pip
 +++++++++++++++++++++++++++++++++++++++++++++++++++++

docs/build/doctrees/index.doctree

@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="features_conceptual/index.html">Features: Conceptual Documentation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Examples</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#getting-started">Getting Started</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#troubleshooting">Troubleshooting</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#import-recommendations-virtual-environment-and-pip">Import Recommendations: Virtual Environment and Pip</a></li>
 </ul>
 </li>
@@ -100,17 +101,18 @@
 <section id="getting-started">
 <h2>Getting Started<a class="headerlink" href="#getting-started" title="Link to this heading"></a></h2>
 <p>To use our tool, please ensure that you have Python &gt;= 3.10 installed and a working version of <a class="reference external" href="https://pypi.org/project/pip/">pip</a>, which is Python’s package installer. Then, in your local environment, run the following:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">team_comm_tools</span>
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>team_comm_tools
 </pre></div>
 </div>
-<p>You will also need to ensure that Spacy and NLTK are installed in addition to the required dependencies. The Spacy model should download <code class="docutils literal notranslate"><span class="pre">en_core_web_sm</span></code> automatically upon install. If you get an error that en_core_web_sm is not found, you should run the following in your terminal:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">spacy</span> <span class="n">download</span> <span class="n">en_core_web_sm</span>
-</pre></div>
-</div>
-<p>Additionally, we require several NLTK dependencies. If you don’t have them in your environment, run this one-liner in your terminal:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">import_nltk</span>
+<p>This command will automatically install our package and all required dependencies.</p>
+<section id="troubleshooting">
+<h3>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to this heading"></a></h3>
+<p>In the event that some dependency installations fail (for example, you may get an error that <code class="docutils literal notranslate"><span class="pre">en_core_web_sm</span></code> from Spacy is not found, or that there is a missing NLTK resource), please run this simple one-line command in your terminal, which will force the installation of Spacy and NLTK dependencies:</p>
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>download_resources
 </pre></div>
 </div>
+<p>If you encounter a further issue in which the ‘wordnet’ package from NLTK is not found, it may be related to a known bug in NLTK in which the wordnet package does not unzip automatically. If this is the case, please follow the instructions to manually unzip it, documented in <a class="reference external" href="https://github.com/nltk/nltk/issues/3028">this thread</a>.</p>
+</section>
 <section id="import-recommendations-virtual-environment-and-pip">
 <h3>Import Recommendations: Virtual Environment and Pip<a class="headerlink" href="#import-recommendations-virtual-environment-and-pip" title="Link to this heading"></a></h3>
 <p><strong>We strongly recommend using a virtual environment in Python to run the package.</strong> We have several specific dependency requirements. One important one is that we are currently only compatible with numpy &lt; 2.0.0 because <a class="reference external" href="https://numpy.org/devdocs/release/2.0.0-notes.html#changes">numpy 2.0.0 and above</a> made significant changes that are not compatible with other dependencies of our package. As those dependencies are updated, we will support later versions of numpy.</p>

docs/build/html/_sources/examples.rst.txt

@@ -83,17 +83,18 @@ <h1>The Team Communication Toolkit<a class="headerlink" href="#the-team-communic
 <section id="getting-started">
 <h2>Getting Started<a class="headerlink" href="#getting-started" title="Link to this heading"></a></h2>
 <p>To use our tool, please ensure that you have Python &gt;= 3.10 installed and a working version of <a class="reference external" href="https://pypi.org/project/pip/">pip</a>, which is Python’s package installer. Then, in your local environment, run the following:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">team_comm_tools</span>
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>team_comm_tools
 </pre></div>
 </div>
-<p>You will also need to ensure that Spacy and NLTK are installed in addition to the required dependencies. The Spacy model should download <code class="docutils literal notranslate"><span class="pre">en_core_web_sm</span></code> automatically upon install. If you get an error that en_core_web_sm is not found, you should run the following in your terminal:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">spacy</span> <span class="n">download</span> <span class="n">en_core_web_sm</span>
-</pre></div>
-</div>
-<p>Additionally, we require several NLTK dependencies. If you don’t have them in your environment, run this one-liner in your terminal:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">import_nltk</span>
+<p>This command will automatically install our package and all required dependencies.</p>
+<section id="troubleshooting">
+<h3>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to this heading"></a></h3>
+<p>In the event that some dependency installations fail (for example, you may get an error that <code class="docutils literal notranslate"><span class="pre">en_core_web_sm</span></code> from Spacy is not found, or that there is a missing NLTK resource), please run this simple one-line command in your terminal, which will force the installation of Spacy and NLTK dependencies:</p>
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>download_resources
 </pre></div>
 </div>
+<p>If you encounter a further issue in which the ‘wordnet’ package from NLTK is not found, it may be related to a known bug in NLTK in which the wordnet package does not unzip automatically. If this is the case, please follow the instructions to manually unzip it, documented in <a class="reference external" href="https://github.com/nltk/nltk/issues/3028">this thread</a>.</p>
+</section>
 <section id="import-recommendations-virtual-environment-and-pip">
 <h3>Import Recommendations: Virtual Environment and Pip<a class="headerlink" href="#import-recommendations-virtual-environment-and-pip" title="Link to this heading"></a></h3>
 <p><strong>We strongly recommend using a virtual environment in Python to run the package.</strong> We have several specific dependency requirements. One important one is that we are currently only compatible with numpy &lt; 2.0.0 because <a class="reference external" href="https://numpy.org/devdocs/release/2.0.0-notes.html#changes">numpy 2.0.0 and above</a> made significant changes that are not compatible with other dependencies of our package. As those dependencies are updated, we will support later versions of numpy.</p>