Metadata-Version: 2.1
Name: lexos
Version: 0.0.1a1
Summary: Lexos is a tool for the analysis of lexical data. The Lexos package is the Python API for the Lexos tool.
Home-page: https://github.com/scottkleinman/lexos
Keywords: text analysis,lexomics,lexos
Author: Scott Kleinman
Author-email: scott.kleinman@csun.edu
Requires-Python: >=3.9,<3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: beautifulsoup4 (>=4.11.1,<5.0.0)
Requires-Dist: catalogue (>=2.0.7,<3.0.0)
Requires-Dist: chardet (>=4.0.0,<5.0.0)
Requires-Dist: cytoolz (==0.12.0)
Requires-Dist: docx2txt (>=0.8,<0.9)
Requires-Dist: natsort (>=8.1.0,<9.0.0)
Requires-Dist: openpyxl (>=3.0.10,<4.0.0)
Requires-Dist: pandas (>=1.4.2,<2.0.0)
Requires-Dist: pdfminer.six (>=20220524,<20220525)
Requires-Dist: plotly (>=5.9.0,<6.0.0)
Requires-Dist: requests (>=2.28.0,<3.0.0)
Requires-Dist: rich (>=12.4.4,<13.0.0)
Requires-Dist: scipy (>=1.8.1,<2.0.0)
Requires-Dist: seaborn (>=0.11.2,<0.12.0)
Requires-Dist: spacy (>=3.4.0,<3.5.0)
Requires-Dist: textacy (>=0.12.0,<0.13.0)
Requires-Dist: typer (>=0.4.1,<0.5.0)
Requires-Dist: wordcloud (>=1.8.1,<2.0.0)
Project-URL: Repository, https://github.com/scottkleinman/lexos
Description-Content-Type: text/markdown

# The Lexos API

[![Release v0.0.1--alpha.1](https://img.shields.io/badge/release-v0.0.1--alpha.1-yellowgreen)](https://github.com//scottkleinman/Lexos/releases)
[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-390/)
[![Python wheels](https://img.shields.io/badge/wheels-%E2%9C%93-4c1.svg?longCache=true&style=flat-square&logo=python&logoColor=white)](https://github.com/scottkleinman/lexos/releases)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/ambv/black)
[![license](https://img.shields.io/github/license/scottkleinman/lexos)](https://img.shields.io/github/license/scottkleinman/lexos)

The Lexos API is a library of methods for programmatically implementing and extending the functionality in the <a href="http://lexos.wheatoncollege.edu/" target="_blank">Lexos</a> text analysis tool. Eventually, the web app will be rewritten to use the API directly. The goal of this alpha stage of development is to reproduce (and in some cases extend) the functionality of the current web app.

## 📖 Documentation

A full discussion of the use of the API can be found on the [Documentation](https://scottkleinman.github.io/lexos/) website.

A suite of Jupyter notebooks demonstrating the functionality can be found [here](https://github.com/scottkleinman/lexos/tree/main/tests/notebooks).

## ⭐️ Features

<li>Loads texts from a variety of sources.</li>
<li>Manages a corpus of texts.</li>
<li>Performs text pre-processing ("scrubbing") and splitting ("cutting").</li>
<li>Performs tokenization and trains language models using <a href="https://spacy.io/" target="_blank">spaCy</a>.</li>
<li>Creates assorted visualizations of term vectors.</li>
<li>Generates topic models and topic model visualizations using <a href="https://github.com/mimno/Mallet" target="_blank">MALLET</a> and <a href="https://github.com/agoldst/dfr-browser" target="_blank">dfr-browser</a>.</li>

An expanded set of features is planned for the future.

## ⏳ Installation

```bash
pip install lexos
```

To update to the latest version, use

```bash
pip install -U lexos
```

## 💝 Contribute

- Bug reports and feature requests: Please use [GitHub issues](https://github.com/scottkleinman/lexos/issues).
- Pull requests: Although we plan to accept pull requests in the near future, we are not yet accepting direct contributions from the wider community.

