abbreviate-names 0.1.2

Uniquely abbreviate a set of names in a language-appropriate way.

abbreviate-names

Uniquely abbreviate a set of names in a language-appropriate way. The original intent was to shorten a collection of Latin species names such that they would fit more nicely into tables and graphs, but other applications abound!

This packages provides both

• a programmatic API, names.abbreviate.abbreviate() and
• a command line tool, abbreviate-names.

If installed with English or Latin options it also includes dependencies on natural language modules which enable it to break names up at syllable boundaries, which produces more readable results:

    pip install 'abbreviate-names[Latin,English]'

Example output

Species	Abbreviation using Latin syllables	.. or by character
Agathidium laevigatum	Agat.lae.	A.l.
Agathidium nigrinum	Agat.nigrinum	A.nigrin.
Agathidium nigripenne	Agat.nigripen.	A.nigrip.
Agathidium seminulum	Agat.se.	A.s.
Agonum ericeti	Ago.e.	A.e.
Agonum fuliginosum	Ago.fu.	A.f.
Agonum gracile	Ago.gra.	A.g.
Lithocharis sp.	Lit.sp.	L.sp.
Xylocleptes bispinus	Xy.bis.	X.b.
Xylodromus concinnus	Xy.con.	X.c.
Xylodromus depressus	Xy.de.	X.d.
Xylostiba monilicornis	Xy.mo.	X.m.
Zeugophora subspinosa	Zeu.sub.	Z.s.

Observe:

• Several different words above are all shortened to “Xy.” or “X.” — it's the whole abbreviation that's unique, not the individual words.
• The already-abbreviated “sp.” is untouched.

Online

• GitHub: https://github.com/ConradHughes/abbreviate-names
• PyPI: https://pypi.org/project/abbreviate-names/

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[0.1.2] - 2020-08-31

Added

• Initial version by @ConradHughes, including
  • library function,
  • command line script,
  • support for Latin and English.