https://github.com/vishusandy/wordfilter

https://github.com/vishusandy/wordfilter

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/vishusandy/wordfilter
• Owner: vishusandy
• License: other
• Created: 2024-03-07T19:53:12.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-03-07T20:45:40.000Z (10 months ago)
• Last Synced: 2024-03-07T21:26:59.940Z (10 months ago)
• Language: Python
• Size: 2.15 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Word Filter

Filters a list of words.  Intended to be used to generate word lists for typing tutors, but may be useful for other purposes.

## Features

- Filters

    - min and max word lengths

    - required characters - filters out words that do not have any of the required characters

    - exclude file - filters out any words found in this file

    - include file - only include words found in this file

- Sorting

    - tiered weights - useful for keyboard tutors to generate lessons that build on previous lessons but prioritize characters in higher tiers

    - ascending and descending alphabetical sorting

    - random shuffling

    - sort by CSV column

- CSV

    - supports automatic detection of csv files (with or without headers)

    - sort by a specified column (numbers and text supported)

    - allows keeping or discarding csv columns in final output (for when you want to sort by a column but not include it in the output)

## Install

```sh

git clone https://github.com/vishusandy/WordFilter.git

cd WordFilter

./install.sh

```

## Usage

```sh

# Basic usage

./run.sh [inputfile] [outputfile]

# Help

./run.sh --help

```

For examples of advanced usage, like using tiered weights, see the [scripts/lessons](https://github.com/vishusandy/WordFilter/tree/main/scripts/lessons) directory.

## License

[Apache-2.0](https://spdx.dev/ids/)