Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/makukha/caseutil

Case convert and verify for Python: snake_case, camelCase, kebab-case, and more.
https://github.com/makukha/caseutil

case case-converter cli python python2 python3 string-case text-case text-case-converter

Last synced: 27 days ago
JSON representation

Case convert and verify for Python: snake_case, camelCase, kebab-case, and more.

Host: GitHub
URL: https://github.com/makukha/caseutil
Owner: makukha
License: mit
Created: 2024-07-27T12:50:24.000Z (3 months ago)
Default Branch: main
Last Pushed: 2024-09-19T05:39:47.000Z (about 2 months ago)
Last Synced: 2024-10-07T20:52:45.638Z (about 1 month ago)
Topics: case, case-converter, cli, python, python2, python3, string-case, text-case, text-case-converter
Language: Python
Homepage: http://caseutil.readthedocs.io
Size: 96.7 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md

Awesome Lists containing this project

README

        # caseutil ⇄ 🐍🐫🍢

> Case convert and verify for Python: snake_case, camelCase, kebab-case, etc.

[![license](https://img.shields.io/github/license/makukha/caseutil.svg)](https://github.com/makukha/caseutil/blob/main/LICENSE)

[![Tests](https://raw.githubusercontent.com/makukha/caseutil/v0.6.5/docs/badge/tests.svg)](https://github.com/makukha/caseutil)

[![Coverage](https://raw.githubusercontent.com/makukha/caseutil/v0.6.5/docs/badge/coverage.svg)](https://github.com/makukha/caseutil)

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9342/badge)](https://www.bestpractices.dev/projects/9342) \

[![pypi](https://img.shields.io/pypi/v/caseutil.svg#v0.6.5)](https://pypi.python.org/pypi/caseutil)

[![versions](https://img.shields.io/pypi/pyversions/caseutil.svg)](https://pypi.org/project/caseutil) \

[![PyPI - Downloads](https://img.shields.io/pypi/dw/caseutil)](https://pypistats.org/packages/caseutil)

[![Documentation Status](https://readthedocs.org/projects/caseutil/badge/?version=latest)](https://caseutil.readthedocs.io/en/latest/?badge=latest)

## Features

* Verify and convert between most popular cases

* Custom separators: `'my.variable.name'`, `'my/variable/name'`

* Command line mode: `caseutil`

* Pure Python 2.7 to 3.13+

* No dependencies

* 100% test coverage

### Supported cases

| Case        | Example          | Functions                |

|-------------|------------------|--------------------------|

| snake_case  | my_variable_name | `is_snake`, `to_snake`   |

| CONST_CASE  | MY_VARIABLE_NAME | `is_const`, `to_const`   |

| camelCase   | myVariableName   | `is_camel`, `to_camel`   |

| PascalCase  | MyVariableName   | `is_pascal`, `to_pascal` |

| kebab-case  | my-variable-name | `is_kebab`, `to_kebab`   |

| lower space | my variable name | `is_lower`, `to_lower`   |

| UPPER SPACE | MY VARIABLE NAME | `is_upper`, `to_upper`   |

| Title Space | My Variable Name | `is_title`, `to_title`   |

## Getting Started

### Installing

```bash

$ pip install caseutil

```

### Use as a library

```doctest

>>> from caseutil import *

```

Verify case format:

```doctest

>>> is_snake('My variable-name')

False

```

Convert to case:

```doctest

>>> to_snake('My variable-name')

'my_variable_name'

```

### Use as a CLI command

Note the support of multiple values in argument or stdin:

```bash

$ caseutil -c const "hi there"

HI_THERE

$ echo "hi_there\nsee you" | python -m caseutil -c camel

hiThere

seeYou

```

## Advanced

### Universal functions

Use functions `is_case()` and `to_case()` to deal with arbitrary case:

```doctest

>>> is_case('camel', 'myVariableName')

True

>>> to_case(Case.CONST, 'myVariableName')

'MY_VARIABLE_NAME'

```

### Case enum

All supported cases are gathered in `Case` enum:

```python

class Case(StrEnum):

    CAMEL = 'camel'

    CONST = 'const'

    KEBAB = 'kebab'

    LOWER = 'lower'

    PASCAL = 'pascal'

    SNAKE = 'snake'

    TITLE = 'title'

    UPPER = 'upper'

```

### Tokenization

Word separators are non-word characters including underscore, and places where text case is changed from lower to upper. Digits are not treated as separators. For more details, see this example and unit tests.

```doctest

>>> words('!some_reallyMESsy text--wit4Digits.3VeryWh3re--')

['some', 'really', 'ME', 'Ssy', 'text', 'wit4', 'Digits', '3Very', 'Wh3re']

```

### Custom Separators

For custom separators, use `words()` function:

```doctest

>>> '/'.join(words(to_lower('myVariableName')))

'my/variable/name'

>>> '.'.join(words('myVariableName'))

'my.Variable.Name'

```

### Unicode support

Only ASCII names are supported. Unicode support is planned.

## Developing

### Development environment

#### OS X

This project requires [Homebrew](https://brew.sh). Other tools like [PDM](https://pdm-project.org) and [Tox](https://tox.wiki) will be installed automatically.

```bash

git clone https://github.com/makukha/caseutil.git

cd caseutil

brew install go-task

task init install

```

### Testing

```bash

task test

```

### Contributing

See [Contributing](.github/CONTRIBUTING.md) guidelines.

### Roadmap

* Add more test, explore edge cases

* Add Unicode support (write tests)

* Add more cases

## Authors

* [Michael Makukha](https://github.com/makukha)

## License

[MIT License](https://github.com/makukha/caseutil/blob/main/LICENSE)