Skip to main content

Lexos is a tool for the analysis of lexical data. The Lexos package is the Python API for the Lexos tool.

Project description

The Lexos API

GitHub release (latest SemVer) Python 3.9 Python wheels Code style: black license

The Lexos API is a library of methods for programmatically implementing and extending the functionality in the Lexos 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 website.

A suite of Jupyter notebooks demonstrating the functionality can be found here.

⭐️ Features

  • Loads texts from a variety of sources.
  • Manages a corpus of texts.
  • Performs text pre-processing ("scrubbing") and splitting ("cutting").
  • Performs tokenization and trains language models using spaCy.
  • Creates assorted visualizations of term vectors.
  • Generates topic models and topic model visualizations using MALLET and dfr-browser.
  • An expanded set of features is planned for the future.

    ⏳ Installation

    pip install lexos
    

    To update to the latest version, use

    pip install -U lexos
    

    Before using Lexos, you will want to install its default language model:

    python -m spacy download xx_sent_ud_sm
    

    This is a minimal model that performs sentence and token segmentation for a variety of languages. If you want a model for a specific language, such as English, download it by providing the name of the model:

    python -m spacy download en_core_web_sm
    

    For information on how Lexos uses language models, see Tokenizing Texts.

    If you are working in another language or need a larger language model, you can download instructions for additional models from the spaCy models page.

    💝 Contribute

    • Bug reports and feature requests: Please use GitHub 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.

    Project details


    Download files

    Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

    Source Distribution

    lexos-0.0.1a1.tar.gz (740.3 kB view details)

    Uploaded Source

    Built Distribution

    lexos-0.0.1a1-py3-none-any.whl (723.0 kB view details)

    Uploaded Python 3

    File details

    Details for the file lexos-0.0.1a1.tar.gz.

    File metadata

    • Download URL: lexos-0.0.1a1.tar.gz
    • Upload date:
    • Size: 740.3 kB
    • Tags: Source
    • Uploaded using Trusted Publishing? No
    • Uploaded via: poetry/1.1.14 CPython/3.9.12 Windows/10

    File hashes

    Hashes for lexos-0.0.1a1.tar.gz
    Algorithm Hash digest
    SHA256 852f2a477eeccbcc51fcf9de3d9d1a2012185d796f6836e011e4a9a4c04c2c88
    MD5 bd9097e3f0149c3db5c97204105fcb2e
    BLAKE2b-256 e5987f561ccf3f0efe171a3eb5c5fed44827457ead06b109ceadaacb4f34f40f

    See more details on using hashes here.

    File details

    Details for the file lexos-0.0.1a1-py3-none-any.whl.

    File metadata

    • Download URL: lexos-0.0.1a1-py3-none-any.whl
    • Upload date:
    • Size: 723.0 kB
    • Tags: Python 3
    • Uploaded using Trusted Publishing? No
    • Uploaded via: poetry/1.1.14 CPython/3.9.12 Windows/10

    File hashes

    Hashes for lexos-0.0.1a1-py3-none-any.whl
    Algorithm Hash digest
    SHA256 892f8b5d88a78085e148326f43c19c48097afd60adb58ae5314a0e50f31469ad
    MD5 f28f44ba89bdff359768d653043edc2a
    BLAKE2b-256 8a2786f43eb1e8cab28cf85a21881a60cc50621748db4eeded780950807ebf97

    See more details on using hashes here.

    Supported by

    AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page