Skip to content
/ casey Public

A simple library to support various naming conventions and convert strings from one to another

License

Notifications You must be signed in to change notification settings

marverix/casey

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Casey

PyPI PyPI - Python Version Codecov GitHub FOSSA Status

A simple library to support various naming conventions and convert strings from one to another.

Casey supports:

  • camelCase
  • PascalCase
  • kebab-case
  • snake_case and SNAKE_CASE

Usage

Installation

pip install casey

Sample

import casey

subject = "every 1 WORD is very IMPORTANT"

print(casey.camel(subject))
# Prints: every1WORDIsVeryIMPORTANT

print(casey.kebab(subject))
# Prints: every-1-WORD-is-very-IMPORTANT

print(casey.pascal(subject))
# Prints: Every1WORDIsVeryIMPORTANT

print(casey.snake(subject))
# Prints: every_1_WORD_is_very_IMPORTANT

print(casey.snake(subject, upper=True))
# Prints: EVERY_1_WORD_IS_VERY_IMPORTANT

def my_transformation(word: str, idx: int) -> str:
  if idx % 2 == 0:
    return word.lower()
  else:
    return word.upper()
  
print(casey.transform(subject, my_transformation, "_"))
# Prints: every_1_word_IS_very_IMPORTANT

API

  • clean(subject: str) -> str: ...

    Returns string with removed cases.

  • camel(subject: str) -> str: ...

    Returns string in camelCase.

  • pascal(subject: str) -> str: ...

    Returns string in PascalCase.

  • kebab(subject: str) -> str: ...

    Returns string in kebab-case.

  • snake(subject: str) -> str: ...

    Returns string in snake_case.

  • snake(subject: str, upper=False) -> str: ...

    Returns string in snake_case.

    If upper is True, it will convert whole subject to upper snake case.

  • upper_first(subject: str) -> str: ...

    Returns string with upper first letter (A-Z).

  • lower_first(subject: str) -> str: ...

    Returns string with lower first letter (A-Z).

  • transform(subject: str, transformation: Callable, glue=" ") -> str: ...

    Returns string transformed by the transformation function. The transformation function accepts 2 parameters: current word index (int), and a word itself (str). Glue is the string used to concat transformed words into one string.

License

This project is licensed under Apache-2.0 License - see the LICENSE file for details.

FOSSA Status