Metadata-Version: 2.1
Name: FolderAnalyse
Version: 0.1.5
Summary: A program that analyses files in a directory with word frequency statistics.
Home-page: http://github.com/rpep/FolderAnalyse
Author: Ryan Alexander Pepper
Author-email: ryan.pepper@soton.ac.uk
License: UNKNOWN
Project-URL: Documentation, https://folderanalyse.readthedocs.io
Project-URL: Source Code, https://github.com/rpep/FolderAnalyse
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >= 3.6
Requires-Dist: pytest

# FolderAnalyse

[![Build Status](https://travis-ci.com/rpep/folder-analyse.svg?branch=master)](https://travis-ci.com/rpep/folder-analyse)
[![Documentation Status](https://readthedocs.org/projects/folderanalyse/badge/?version=latest)](https://folderanalyse.readthedocs.io/en/latest/?badge=latest)

FolderAnalyse is an application which provides word frequency statistics about files.
It is designed for use primarily as a command line application, but it can also be 
used as a library.

To install FolderAnalyse, simply install from PyPi via:

```bash
python3 -m pip install FolderAnalyse
```

Alternatively, to try out the latest version, install directly from GitHub with:

```bash
python3 -m pip install git+https://github.com/rpep/FolderAnalyse
```

After that, FolderAnalyse will be available at the command line; to view the help
simply call

```bash
FolderAnalyse -h
```

For documentation on how to use FolderAnalyse, please see the documentation
[here](https://folderanalyse.readthedocs.io/en/latest/).


