Skip to content

Commit f60efed

Browse files
committed
Cleanup
1 parent b829706 commit f60efed

30 files changed

+14115
-1314
lines changed

Pipfile

-15
This file was deleted.

Pipfile.lock

-469
This file was deleted.

docs/_build/html/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 79bdbaeec2b9ad4426f961039ddd1e93
3+
config: 6ad6e3e11231cea41b34beb1c2b191c5
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
11.8 KB
Binary file not shown.
25.3 KB
Binary file not shown.
32.7 KB
Binary file not shown.
29.7 KB
Binary file not shown.

docs/_build/html/_modules/index.html

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11

2-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<!DOCTYPE html>
43

5-
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<html>
65
<head>
7-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
98
<title>Overview: module code &#8212; rake-nltk 1.0.4 documentation</title>
10-
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
11-
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12-
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
13-
<script type="text/javascript" src="../_static/jquery.js"></script>
14-
<script type="text/javascript" src="../_static/underscore.js"></script>
15-
<script type="text/javascript" src="../_static/doctools.js"></script>
9+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
10+
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
11+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
12+
<script src="../_static/jquery.js"></script>
13+
<script src="../_static/underscore.js"></script>
14+
<script src="../_static/doctools.js"></script>
1615
<link rel="index" title="Index" href="../genindex.html" />
1716
<link rel="search" title="Search" href="../search.html" />
1817

@@ -50,28 +49,29 @@ <h3>Stay Connected</h3>
5049

5150
<p><a href="https://twitter.com/sharmavishwas7" class="twitter-follow-button" data-show-count="false">Follow @sharmavishwas7</a> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script></p>
5251
<div id="searchbox" style="display: none" role="search">
53-
<h3>Quick search</h3>
52+
<h3 id="searchlabel">Quick search</h3>
5453
<div class="searchformwrapper">
5554
<form class="search" action="../search.html" method="get">
56-
<input type="text" name="q" />
55+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
5756
<input type="submit" value="Go" />
58-
<input type="hidden" name="check_keywords" value="yes" />
59-
<input type="hidden" name="area" value="default" />
6057
</form>
6158
</div>
6259
</div>
63-
<script type="text/javascript">$('#searchbox').show(0);</script>
60+
<script>$('#searchbox').show(0);</script>
6461
</div>
6562
</div>
6663
<div class="documentwrapper">
6764
<div class="bodywrapper">
65+
66+
6867
<div class="body" role="main">
6968

7069
<h1>All modules for which code is available</h1>
7170
<ul><li><a href="rake_nltk/rake.html">rake_nltk.rake</a></li>
7271
</ul>
7372

7473
</div>
74+
7575
</div>
7676
</div>
7777
<div class="clearer"></div>
@@ -80,8 +80,8 @@ <h1>All modules for which code is available</h1>
8080
&copy;2018, Vishwas B Sharma.
8181

8282
|
83-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
84-
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
83+
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
84+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
8585

8686
</div>
8787

docs/_build/html/_modules/rake_nltk/rake.html

+26-30
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11

2-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<!DOCTYPE html>
43

5-
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<html>
65
<head>
7-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
98
<title>rake_nltk.rake &#8212; rake-nltk 1.0.4 documentation</title>
10-
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
11-
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
12-
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
13-
<script type="text/javascript" src="../../_static/jquery.js"></script>
14-
<script type="text/javascript" src="../../_static/underscore.js"></script>
15-
<script type="text/javascript" src="../../_static/doctools.js"></script>
9+
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
10+
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css" />
11+
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
12+
<script src="../../_static/jquery.js"></script>
13+
<script src="../../_static/underscore.js"></script>
14+
<script src="../../_static/doctools.js"></script>
1615
<link rel="index" title="Index" href="../../genindex.html" />
1716
<link rel="search" title="Search" href="../../search.html" />
1817

@@ -50,21 +49,21 @@ <h3>Stay Connected</h3>
5049

5150
<p><a href="https://twitter.com/sharmavishwas7" class="twitter-follow-button" data-show-count="false">Follow @sharmavishwas7</a> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script></p>
5251
<div id="searchbox" style="display: none" role="search">
53-
<h3>Quick search</h3>
52+
<h3 id="searchlabel">Quick search</h3>
5453
<div class="searchformwrapper">
5554
<form class="search" action="../../search.html" method="get">
56-
<input type="text" name="q" />
55+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
5756
<input type="submit" value="Go" />
58-
<input type="hidden" name="check_keywords" value="yes" />
59-
<input type="hidden" name="area" value="default" />
6057
</form>
6158
</div>
6259
</div>
63-
<script type="text/javascript">$('#searchbox').show(0);</script>
60+
<script>$('#searchbox').show(0);</script>
6461
</div>
6562
</div>
6663
<div class="documentwrapper">
6764
<div class="bodywrapper">
65+
66+
6867
<div class="body" role="main">
6968

7069
<h1>Source code for rake_nltk.rake</h1><div class="highlight"><pre>
@@ -76,12 +75,12 @@ <h1>Source code for rake_nltk.rake</h1><div class="highlight"><pre>
7675
<span class="sd">&quot;&quot;&quot;</span>
7776

7877
<span class="kn">import</span> <span class="nn">string</span>
79-
<span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">Counter</span><span class="p">,</span> <span class="n">defaultdict</span>
80-
<span class="kn">from</span> <span class="nn">itertools</span> <span class="k">import</span> <span class="n">chain</span><span class="p">,</span> <span class="n">groupby</span><span class="p">,</span> <span class="n">product</span>
78+
<span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">Counter</span><span class="p">,</span> <span class="n">defaultdict</span>
79+
<span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
80+
<span class="kn">from</span> <span class="nn">itertools</span> <span class="kn">import</span> <span class="n">chain</span><span class="p">,</span> <span class="n">groupby</span><span class="p">,</span> <span class="n">product</span>
8181

8282
<span class="kn">import</span> <span class="nn">nltk</span>
83-
<span class="kn">from</span> <span class="nn">enum</span> <span class="k">import</span> <span class="n">Enum</span>
84-
<span class="kn">from</span> <span class="nn">nltk.tokenize</span> <span class="k">import</span> <span class="n">wordpunct_tokenize</span>
83+
<span class="kn">from</span> <span class="nn">nltk.tokenize</span> <span class="kn">import</span> <span class="n">wordpunct_tokenize</span>
8584

8685

8786
<div class="viewcode-block" id="Metric"><a class="viewcode-back" href="../../api.html#rake_nltk.Metric">[docs]</a><span class="k">class</span> <span class="nc">Metric</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
@@ -95,11 +94,11 @@ <h1>Source code for rake_nltk.rake</h1><div class="highlight"><pre>
9594
<div class="viewcode-block" id="Rake"><a class="viewcode-back" href="../../api.html#rake_nltk.Rake">[docs]</a><span class="k">class</span> <span class="nc">Rake</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
9695
<span class="sd">&quot;&quot;&quot;Rapid Automatic Keyword Extraction Algorithm.&quot;&quot;&quot;</span>
9796

98-
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span>
97+
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
9998
<span class="bp">self</span><span class="p">,</span>
10099
<span class="n">stopwords</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
101100
<span class="n">punctuations</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
102-
<span class="n">language</span><span class="o">=</span><span class="s2">&quot;english&quot;</span><span class="p">,</span>
101+
<span class="n">language</span><span class="o">=</span><span class="s1">&#39;english&#39;</span><span class="p">,</span>
103102
<span class="n">ranking_metric</span><span class="o">=</span><span class="n">Metric</span><span class="o">.</span><span class="n">DEGREE_TO_FREQUENCY_RATIO</span><span class="p">,</span>
104103
<span class="n">max_length</span><span class="o">=</span><span class="mi">100000</span><span class="p">,</span>
105104
<span class="n">min_length</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
@@ -241,7 +240,7 @@ <h1>Source code for rake_nltk.rake</h1><div class="highlight"><pre>
241240
<span class="n">rank</span> <span class="o">+=</span> <span class="mf">1.0</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">degree</span><span class="p">[</span><span class="n">word</span><span class="p">]</span>
242241
<span class="k">else</span><span class="p">:</span>
243242
<span class="n">rank</span> <span class="o">+=</span> <span class="mf">1.0</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">frequency_dist</span><span class="p">[</span><span class="n">word</span><span class="p">]</span>
244-
<span class="bp">self</span><span class="o">.</span><span class="n">rank_list</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">rank</span><span class="p">,</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">phrase</span><span class="p">)))</span>
243+
<span class="bp">self</span><span class="o">.</span><span class="n">rank_list</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">rank</span><span class="p">,</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">phrase</span><span class="p">)))</span>
245244
<span class="bp">self</span><span class="o">.</span><span class="n">rank_list</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">reverse</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
246245
<span class="bp">self</span><span class="o">.</span><span class="n">ranked_phrases</span> <span class="o">=</span> <span class="p">[</span><span class="n">ph</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">for</span> <span class="n">ph</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">rank_list</span><span class="p">]</span>
247246

@@ -285,14 +284,11 @@ <h1>Source code for rake_nltk.rake</h1><div class="highlight"><pre>
285284
<span class="sd"> &quot;&quot;&quot;</span>
286285
<span class="n">groups</span> <span class="o">=</span> <span class="n">groupby</span><span class="p">(</span><span class="n">word_list</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">to_ignore</span><span class="p">)</span>
287286
<span class="n">phrases</span> <span class="o">=</span> <span class="p">[</span><span class="nb">tuple</span><span class="p">(</span><span class="n">group</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="k">for</span> <span class="n">group</span> <span class="ow">in</span> <span class="n">groups</span> <span class="k">if</span> <span class="n">group</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span>
288-
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span>
289-
<span class="nb">filter</span><span class="p">(</span>
290-
<span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">min_length</span> <span class="o">&lt;=</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_length</span><span class="p">,</span> <span class="n">phrases</span>
291-
<span class="p">)</span>
292-
<span class="p">)</span></div>
287+
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">min_length</span> <span class="o">&lt;=</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_length</span><span class="p">,</span> <span class="n">phrases</span><span class="p">))</span></div>
293288
</pre></div>
294289

295290
</div>
291+
296292
</div>
297293
</div>
298294
<div class="clearer"></div>
@@ -301,8 +297,8 @@ <h1>Source code for rake_nltk.rake</h1><div class="highlight"><pre>
301297
&copy;2018, Vishwas B Sharma.
302298

303299
|
304-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
305-
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
300+
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
301+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
306302

307303
</div>
308304

docs/_build/html/_sources/index.rst.txt

+10-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,16 @@ Please use `issue tracker`_ for reporting bugs or feature requests.
122122
Development
123123
~~~~~~~~~~~
124124

125-
Pull requests are most welcome.
125+
1. Checkout the repository.
126+
2. Make your changes and add/update relavent tests.
127+
3. Install **`poetry`** using **`pip install poetry`**.
128+
4. Run **`poetry install`** to create project's virtual environment.
129+
5. Run tests using **`poetry run tox`** (Any python versions which you don't have checked out will fail this). Fix failing tests and repeat.
130+
6. Make documentation changes that are relavant.
131+
7. Install **`pre-commit`** using **`pip install pre-commit`** and run **`pre-commit run --all-files`** to do lint checks.
132+
8. Generate documentation using **`poetry run sphinx-build -b html docs/ docs/_build/html`**.
133+
9. Generate **`requirements.txt`** for automated testing using **`poetry export --dev --without-hashes -f requirements.txt > requirements.txt`**.
134+
10. Commit the changes and raise a pull request.
126135

127136
Buy the developer a cup of coffee!
128137
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)