Skip to content

tvquizphd/abeci

Repository files navigation

abeci

Create perfect pangrams, sentences with exactly one of each letter in the English alphabet.

Generate Pangrams

After installing abeci as a package, you can run:

abeci-pangrams

This script makes a text file with this name, in results by default:

./results/std4_max1_has_2x_3x/pangrams_1024_0x1_128x2_512x3_1024x4.txt

If the effects/source.p file is missing,

  • The script uses Google's English Corpus of all books published in 2008.
  • The script will write an effects/source.p to speed up future calls to the script.

it also:

  • writes a log file such as 2022-04-07T0200.log, with UTC time.
  • writes intermediate files in an effects directory.

Run the help command for options: abeci-pangrams -h

API Usage

  • No programatic api is documented at this time:
  • Look to src/abeci/savePangrams.py for inspiration

Local Installation

Dependencies

Install Miniconda or Anaconda.

conda env create -f environment.yaml

or

conda env update -f environment.yaml

Then, activate the installed environment:

conda activate abeci

After installing dependencies, you can run:

python src/pangrams.py

Run the help command for options: python src/pangrams.py -h

Build Locally w/ pip

Upgrade pip and build with pip

python -m pip install --upgrade pip
pip install build

Install Locally

Using the conda environment, install locally with pip:

VIRTUAL_ENV=$CONDA_PREFIX pip install --src $VIRTUAL_ENV/src -e .

Test

After installing locally, run:

bash run_test.sh

Publish

Publishing happens on release. The following two links were inspirations: