added slufigy() and is_slug()

Author: daveoncode

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Python String Utils Changelog
 
+## v0.6.0
+
+### Added:
+
+- slugify
+- is_slug
+
 ## v0.5.0
 
 ### Added:

README.md

@@ -28,6 +28,7 @@ A small utility library to check and manipulate strings.
 - is_pangram
 - is_palindrome
 - is_isogram
+- is_slug
 - words_count
 - contains_html
 
@@ -40,6 +41,7 @@ A small utility library to check and manipulate strings.
 - shuffle
 - strip_html
 - prettify
+- slugify
 
 
 ...and more are coming!

docs/_build/doctrees/environment.pickle

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: a207946dbf2ca7a53a400cd856a07176
+config: 795fda3a4963648736253334baf00dc7
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/doctrees/index.doctree

@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Python String Utils's documentation!
-===============================================
+string_utils documentation
+==========================
 
 Contents:
 

docs/_build/html/.buildinfo

@@ -9,7 +9,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Index &mdash; Python String Utils 0.5.0 documentation</title>
+  <title>Index &mdash; Python String Utils 0.6.0 documentation</title>
 
 
 
@@ -34,7 +34,7 @@
         <link rel="index" title="Index"
               href="#"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="Python String Utils 0.5.0 documentation" href="index.html"/> 
+    <link rel="top" title="Python String Utils 0.6.0 documentation" href="index.html"/> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                0.5.0
+                0.6.0
               </div>
 
 
@@ -181,12 +181,12 @@ <h2 id="I">I</h2>
   <dt><a href="index.html#string_utils.is_isogram">is_isogram() (in module string_utils)</a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="index.html#string_utils.is_json">is_json() (in module string_utils)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="index.html#string_utils.is_palindrome">is_palindrome() (in module string_utils)</a>
   </dt>
@@ -196,6 +196,10 @@ <h2 id="I">I</h2>
   </dt>
 
 
+  <dt><a href="index.html#string_utils.is_slug">is_slug() (in module string_utils)</a>
+  </dt>
+
+      
   <dt><a href="index.html#string_utils.is_snake_case">is_snake_case() (in module string_utils)</a>
   </dt>
 
@@ -242,12 +246,16 @@ <h2 id="S">S</h2>
   </dt>
 
 
-  <dt><a href="index.html#string_utils.snake_case_to_camel">snake_case_to_camel() (in module string_utils)</a>
+  <dt><a href="index.html#string_utils.slugify">slugify() (in module string_utils)</a>
   </dt>
 
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
 
+  <dt><a href="index.html#string_utils.snake_case_to_camel">snake_case_to_camel() (in module string_utils)</a>
+  </dt>
+
+      
   <dt><a href="index.html#module-string_utils">string_utils (module)</a>
   </dt>
 
@@ -311,7 +319,7 @@ <h2 id="W">W</h2>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'0.5.0',
+            VERSION:'0.6.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

docs/_build/html/_sources/index.txt

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Welcome to Python String Utils’s documentation! &mdash; Python String Utils 0.5.0 documentation</title>
+  <title>string_utils documentation &mdash; Python String Utils 0.6.0 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="Python String Utils 0.5.0 documentation" href="#"/> 
+    <link rel="top" title="Python String Utils 0.6.0 documentation" href="#"/> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                0.5.0
+                0.6.0
               </div>
 
 
@@ -84,7 +84,7 @@
 
                 <!-- Local TOC -->
                 <div class="local-toc"><ul>
-<li><a class="reference internal" href="#">Welcome to Python String Utils&#8217;s documentation!</a></li>
+<li><a class="reference internal" href="#">string_utils documentation</a></li>
 <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
 </ul>
 </div>
@@ -116,7 +116,7 @@
   <ul class="wy-breadcrumbs">
     <li><a href="#">Docs</a> &raquo;</li>
 
-    <li>Welcome to Python String Utils&#8217;s documentation!</li>
+    <li>string_utils documentation</li>
       <li class="wy-breadcrumbs-aside">
 
 
@@ -130,8 +130,8 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <div class="section" id="welcome-to-python-string-utils-s-documentation">
-<h1>Welcome to Python String Utils&#8217;s documentation!<a class="headerlink" href="#welcome-to-python-string-utils-s-documentation" title="Permalink to this headline">¶</a></h1>
+  <div class="section" id="string-utils-documentation">
+<h1>string_utils documentation<a class="headerlink" href="#string-utils-documentation" title="Permalink to this headline">¶</a></h1>
 <p>Contents:</p>
 <div class="toctree-wrapper compound">
 </div>
@@ -420,6 +420,27 @@ <h1>Welcome to Python String Utils&#8217;s documentation!<a class="headerlink" h
 </table>
 </dd></dl>
 
+<dl class="function">
+<dt id="string_utils.is_slug">
+<code class="descclassname">string_utils.</code><code class="descname">is_slug</code><span class="sig-paren">(</span><em>string</em>, <em>sign='-'</em><span class="sig-paren">)</span><a class="headerlink" href="#string_utils.is_slug" title="Permalink to this definition">¶</a></dt>
+<dd><p>Checks if a given string is a slug.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>string</strong> (<em>str</em>) &#8211; String to check.</li>
+<li><strong>sign</strong> (<em>str</em>) &#8211; Join sign used by the slug.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">True if slug, false otherwise.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 <dl class="function">
 <dt id="string_utils.words_count">
 <code class="descclassname">string_utils.</code><code class="descname">words_count</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#string_utils.words_count" title="Permalink to this definition">¶</a></dt>
@@ -596,7 +617,7 @@ <h1>Welcome to Python String Utils&#8217;s documentation!<a class="headerlink" h
 <ul class="simple">
 <li>String cannot start or end with spaces</li>
 <li>String cannot have multiple sequential spaces, empty lines or punctuation (except for &#8221;?&#8221;, &#8221;!&#8221; and &#8221;.&#8221;)</li>
-<li>Arithmetic operators (&#8220;+&#8221;, &#8220;-&#8221;, &#8220;/&#8221;, &#8220;*&#8221;, &#8220;=&#8221;) must have one, and only one space before and after themselves</li>
+<li>Arithmetic operators (+, -, /, *, =) must have one, and only one space before and after themselves</li>
 <li>The first letter after a dot, an exclamation or a question mark must be uppercase</li>
 <li>One, and only one space should follow a dot, an exclamation or a question mark</li>
 <li>Text inside double quotes cannot start or end with spaces, but one, and only one space must come first and     after quotes (foo&#8221; bar&#8221;baz -&gt; foo &#8220;bar&#8221; baz)</li>
@@ -618,6 +639,28 @@ <h1>Welcome to Python String Utils&#8217;s documentation!<a class="headerlink" h
 </table>
 </dd></dl>
 
+<dl class="function">
+<dt id="string_utils.slugify">
+<code class="descclassname">string_utils.</code><code class="descname">slugify</code><span class="sig-paren">(</span><em>string</em>, <em>sign='-'</em><span class="sig-paren">)</span><a class="headerlink" href="#string_utils.slugify" title="Permalink to this definition">¶</a></dt>
+<dd><p>Converts a string into a slug using provided join sign.
+(<strong>(This Is A &#8220;Test&#8221;!)</strong> -&gt; <strong>this-is-a-test</strong>)</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>string</strong> (<em>str</em>) &#8211; String to convert.</li>
+<li><strong>sign</strong> (<em>str</em>) &#8211; Sign used to join string tokens (default to &#8220;-&#8221;).</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Slugified string</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 </div>
 <div class="section" id="indices-and-tables">
 <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
@@ -660,7 +703,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'0.5.0',
+            VERSION:'0.6.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

docs/_build/html/genindex.html

@@ -1,7 +1,6 @@
 # Sphinx inventory version 2
 # Project: Python String Utils
-# Version: 0.5.0
+# Version: 0.6.0
 # The remainder of this file is compressed using zlib.
-xڝ��N�0��}� �8ub׽
�I��1
-����
��$�Ɔ@Hޭ����ql#%�'��Xqٹ��� ������f��D��|3(V
-AR����#��2����!���I����Ay��hCL��S��㘭���Md�1LI9�E�"��E��.��魽t�_S/���OL@dƅ�$x�ĺ;�y-��.q�u�8t����e�#$]f6dO�S��"��Ϊ�r�~+N�U'�gw��0Tх��P����/4�@��Mǚ�=��dei�,n�������h�>����#�4�?�fk�C�����0�
+xڝ�KN�0��=E$�v�l�,��8@��%;
z{�F���<���?ۉ]SFfY�u$�z���A�`��d��m��@�I+NjE s��;�S	:����7CV6�lngI����hx xe�5N�9ٍ<�&�����7�*���
+��\��G�0_m��F�d�B)�3p	!g;���uwZ�49Q�«joJ[�_ˡ�!q��?#��b	�j��Yesq��d<��uӉ��9�2u�ܢ����[ơ.�?�u�:z����{*�z�It[�t���a��"�

docs/_build/html/index.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Python Module Index &mdash; Python String Utils 0.5.0 documentation</title>
+  <title>Python Module Index &mdash; Python String Utils 0.6.0 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="Python String Utils 0.5.0 documentation" href="index.html"/>
+    <link rel="top" title="Python String Utils 0.6.0 documentation" href="index.html"/>
 
 
     <script type="text/javascript">
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                0.5.0
+                0.6.0
               </div>
 
 
@@ -181,7 +181,7 @@ <h1>Python Module Index</h1>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'0.5.0',
+            VERSION:'0.6.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

docs/_build/html/objects.inv

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Search &mdash; Python String Utils 0.5.0 documentation</title>
+  <title>Search &mdash; Python String Utils 0.6.0 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="#"/>
-    <link rel="top" title="Python String Utils 0.5.0 documentation" href="index.html"/> 
+    <link rel="top" title="Python String Utils 0.6.0 documentation" href="index.html"/> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                0.5.0
+                0.6.0
               </div>
 
 
@@ -167,7 +167,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'0.5.0',
+            VERSION:'0.6.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

docs/_build/html/py-modindex.html

@@ -58,9 +58,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.5.0'
+version = '0.6.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.5.0'
+release = '0.6.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/_build/html/search.html

@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Python String Utils's documentation!
-===============================================
+string_utils documentation
+==========================
 
 Contents:
 

docs/_build/html/searchindex.js

@@ -5,7 +5,7 @@
 
 setup(
     name='python-string-utils',
-    version='0.5.0',
+    version='0.6.0',
     description='Utility functions for strings checking and manipulation.',
     long_description=long_description,
     author='Davide Zanotti',