pysimilar
A python library for computing the similarity between two string(text) based on cosine similarity made by kalebu
How does it work ?
It uses Tfidf Vectorizer to transform the text into vectors and then obtained vectors are converted into arrays of numbers and then finally cosine similary computation is employed resulting to output indicating how similar they are.
Example of usage
Pysimilar allows you to either specify the string you want to compare directly or specify path to files containing string you want to compare.
compare() strings
Here an example on how to compare strings directly;
>>> from pysimilar import compare
>>> compare('very light indeed', 'how fast is light')
0.17077611319011649
compare () files
Here how to compare files with textual documents;
>>> compare('README.md', 'LICENSE', isfile=True)
0.25545580376557886
You can also compare documents with particular extension in a given directory, for instance let's say I want to compare all the documents with .txt in a documents directory here is what I will do;
Directory for documents used by the example below look like this
documents/
├── anomalie.zeta
├── hello.txt
├── hi.txt
└── welcome.txt
compare_documents ()
Here how to compare files of a particular extension
>>> import pysimilar
>>> from pprint import pprint
>>> pysimilar.extensions = '.txt'
>>> comparison_result = pysimilar.compare_documents('documents')
>>> [['welcome.txt vs hi.txt', 0.6053485081062917],
['welcome.txt vs hello.txt', 0.0],
['hi.txt vs hello.txt', 0.0]]
sorting the outputs
You can also sort the comparison score based on their score by changing the ascending parameter, just as shown below;
>>> comparison_result = pysimilar.compare_documents('documents', ascending=True)
>>> pprint(comparison_result)
[['welcome.txt vs hello.txt', 0.0],
['hi.txt vs hello.txt', 0.0],
['welcome.txt vs hi.txt', 0.6053485081062917]]
multiple extensions
You can also set pysimilar to include files with multiple extensions
>>> import pysimilar
>>> from pprint import pprint
>>> pysimilar.extensions = ['.txt', '.zeta']
>>> comparison_result = pysimilar.compare_documents('documents', ascending=True)
>>> pprint(comparison_result)
[['welcome.txt vs hello.txt', 0.0],
['hi.txt vs hello.txt', 0.0],
['anomalie.zeta vs hi.txt', 0.4968161174826459],
['welcome.txt vs hi.txt', 0.6292275146695526],
['welcome.txt vs anomalie.zeta', 0.7895651507603823]]
Contributions
If you have anything valuable to add to the lib, whether its a documentation, typo error, source code, please don't hesitate to contribute just fork it and submit your pull request and I will try to be as friendly as I can to assist you making the contributions.
All the Credits
All the Credits to kalebu and other future contributors
Metadata
Release files for pysimilar 0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pysimilar-0.5-py3-none-any.whl | Python 3 | none | any | Details for pysimilar-0.5-py3-none-any.whl |
Release files / pysimilar-0.5-py3-none-any.whl
| Download URL | pysimilar-0.5-py3-none-any.whl |
|---|---|
| Size | 5.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fb729c5c0d1389eb2d304297279da7fcaaf566be174501027ce3fc891d73e7fd
|
|
BLAKE2b-256 checksum How to use checksums |
158cd285efb796b21531fbe412eb86055e2b1a93d7faae51bc73de12486d4011
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10
|
Security for pysimilar 0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.