Metadata-Version: 2.1
Name: substr
Version: 0.0.1
Summary: Python package for working with substrings.
Home-page: https://github.com/CodeConfidant/substr
Author: Drew Hainer
Author-email: codeconfidant@gmail.com
License: MIT
Platform: Windows
Platform: Linux
Description-Content-Type: text/markdown
License-File: LICENSE

# ***substr***

    Python package for working with substrings.

    Make sure to have the latest version of Python 3 installed although this should work with previous versions. 

    To install the package with pip enter command in terminal:
        pip install substr

    To uninstall the package with pip enter command in terminal:
        pip uninstall substr

<table width="100%">
	<tr>
		<th align="left">
            Method
        </th>
		<th align="left">
            Description
        </th>
	</tr>
	<tr>
		<td>
            <code>get_substring(string)</code>
        </td>
		<td>
            Get all substrings from string argument.
        </td>
	</tr>
    <tr>
		<td>
            <code>get_matching_substring(string, compare_values)</code>
        </td>
		<td>
            Find substrings in argument string containing all characters in argument list.
        </td>
	</tr>
    <tr>
		<td>
            <code>get_small_matching_substring(string, compare_values)</code>
        </td>
		<td>
            Find smallest substring in argument string containing all characters in argument list.
        </td>
	</tr>
    
</table>

[Back to Top](#substr)

---
