Metadata-Version: 2.1
Name: excel-ngrams
Version: 0.1.2
Summary: An app to output n-grams from column in Excel spreadsheet
Home-page: https://github.com/mattyocode/excel-ngrams
Keywords: Excel,n-grams
Author: Matthew Oliver
Author-email: matthewoliver@live.co.uk
Requires-Python: >=3.7.1,<4.0.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: XlsxWriter (>=1.3.7,<2.0.0)
Requires-Dist: click (>=7.1.2,<8.0.0)
Requires-Dist: importlib-metadata (>=3.4.0,<4.0.0); python_version < "3.8"
Requires-Dist: nltk (>=3.5,<4.0)
Requires-Dist: openpyxl (>=3.0.6,<4.0.0)
Requires-Dist: pandas (>=1.2.1,<2.0.0)
Requires-Dist: spacy (>=2.3.5,<3.0.0)
Project-URL: Repository, https://github.com/mattyocode/excel-ngrams
Description-Content-Type: text/markdown

[![Tests](https://github.com/mattyocode/excel-ngrams/workflows/Tests/badge.svg)](https://github.com/mattyocode/excel-ngrams/actions?workflow=Tests)

[![codecov](https://codecov.io/gh/mattyocode/excel-ngrams/branch/main/graph/badge.svg?token=0621CKX30T)](https://codecov.io/gh/mattyocode/excel-ngrams)

[![PyPI](https://img.shields.io/pypi/v/excel-ngrams.svg)](https://pypi.org/project/excel-ngrams/)

# The Excel Ngrams Project

A project to analyse a column of text in an Excel document and
return a CSV file with the most common ngrams from that text. Output
file is returned to the same directory as the input file.

You can choose the maximum n-gram length, and maximum number of
results (rows) returned. The app defaults to looking for a column
named'Keyword' but any column name can be passed in as an argument.

The column of terms to analyse must be the longest (or only) column
in the document to prevent the addition of NaN as a placeholder in
final cells, which will cause errors.


Words are tokenised with Spacy and ngrams are generated with NLTK.




## Installation

To install the Excel Ngrams Project,
run this command in your terminal:


$ pip install excel-ngrams


![Excel-ngrams-usage](https://media.giphy.com/media/L3QRuhyMhdgUWNtwFp/giphy.gif)

