Metadata-Version: 2.1
Name: lsframe
Version: 1.0
Summary: lsframe - map, classify, frame
Home-page: https://github.com/thcasey3/lsframe
Author: Thomas Casey
License: MIT
Download-URL: https://github.com/thcasey3/lsframe/
Project-URL: Homepage, https://thcasey3.github.io/lsframe/
Project-URL: Documentation, https://thcasey3.github.io/lsframe/
Project-URL: Source, https://github.com/thcasey3/lsframe/
Keywords: classify language recognition
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: python-dateutil (>=2.6.1)
Requires-Dist: numpy (>=1.13.3)
Requires-Dist: pandas (>=1.0.4)
Requires-Dist: seaborn (>=0.10)

# lsframe - map, classify, frame

[![https://thcasey3.github.io/lsframe/](https://img.shields.io/pypi/v/lsframe)](https://pypi.org/project/lsframe/)
[![Website](https://img.shields.io/website?down_message=offline&label=Documentation&up_message=online&url=https%3A%2F%2Fthcasey3.github.io%2Flsframe%2Findex.html)](https://thcasey3.github.io/lsframe/)

lsframe is an open-source Python package for mapping directories and correlating specific language patterns in file and folder names with each other and with outputs of user-supplied functions.

# Features

- Create DataFrames that are maps of directories
- Organize DataFrames using dates and language in file and folder names
- Find possible dates in arbitrarily formatted file and folder names 
- Construct DataFrames from a function that processes files and folders
- Visualize correlations between dates or language and function outputs

# Requirements

  - Python 3.6 or Later
  - pandas, numpy, python-dateutil, seaborn

Install the required packages using pip:
```console
pip install pandas numpy python-dateutil seaborn
```

# Installation

Install lsframe using pip:

```console
pip install lsframe
```

# Documenation

- Online documentation: https://thcasey3.github.io/lsframe/

# Developement 

  - Clone the git repository from https://github.com/thcasey3/lsframe/tree/development


