Giter Site home page Giter Site logo

souvlaki's Introduction

Souvlaki

Souvlaki is a simple utility for generating memorable names from strings of adjectives and nouns.

Usage

A souvlaki spec (recipe?) is a string of ADJ and NOUN tokens separated by DELIMITERs and optionally preceded by a positive INTEGER.

An ADJ token is one of the following:

  • adj, Adj, $Adj, ADJ

A NOUN token is one of the following:

  • noun, Noun, $Noun, NOUN

A DELIMITER is one of the following:

  • -, (space), _, ., +, /, :, &

Souvlaki will replace adjective and noun tokens with adjectives and nouns, respectively. The capitalization style of the token (lower, Title, UPPER) will be copied. If the token uses the $Title style, souvlaki will ensure the first letter is capitalized but will not modify the rest of the word - so taco becomes Taco, but ICBM remains ICBM.

The special delimiter & indicates that words should be directly concatenated (so adj&adj might yield angryred).

See examples/example.py for an example.

Why "souvlaki"?

Names are often generated in the format adj-adj-noun (like sintered-ductile-diode), which is typically called "kebab case" since it looks like a kebab. kebab was already taken on PyPI, and souvlaki was the next best thing.

souvlaki's People

Contributors

jacobdeery avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.