PkgFoundry
Catalog PyPI
Back to packageRELEASE DETAILS

0.1.2

PyPI

abbreviate-names

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

abbreviateenglishlatinnames
Published31 Aug 2020
Direct dependencies2
Transitive dependenciesNot calculated

README

Version 0.1.2 documentation

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

SpeciesAbbreviation using Latin syllables.. or by character
Agathidium laevigatumAgat.lae.A.l.
Agathidium nigrinumAgat.nigrinumA.nigrin.
Agathidium nigripenneAgat.nigripen.A.nigrip.
Agathidium seminulumAgat.se.A.s.
Agonum ericetiAgo.e.A.e.
Agonum fuliginosumAgo.fu.A.f.
Agonum gracileAgo.gra.A.g.
Lithocharis sp.Lit.sp.L.sp.
Xylocleptes bispinusXy.bis.X.b.
Xylodromus concinnusXy.con.X.c.
Xylodromus depressusXy.de.X.d.
Xylostiba monilicornisXy.mo.X.m.
Zeugophora subspinosaZeu.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

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.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 2

Native requirements
2 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
nltk
Environment
{
  "extras": "",
  "marker": "extra == 'english'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
nltk (>=3.5) ; extra == 'english'runtime
cltk
Environment
{
  "extras": "",
  "marker": "extra == 'latin'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
cltk (>=0.1.121) ; extra == 'latin'runtime

Distribution files

2 collected
abbreviate_names-0.1.2-py3-none-any.whl

bdist_wheel · 18.59 KB · Python py3

Source file
abbreviate-names-0.1.2.tar.gz

sdist · 5.62 KB · Python source

Source file

Repository

PENDING
conradhughes/abbreviate-names

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:11 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:b8aa4f54337cde9bd05685f2e6cc7ef14eadbc98bfb746772685a009ff01eacd

Other collected versions

View all collected versions →