File: README.md

package info (click to toggle)
nim-unicodeplus 0.5.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 104 kB
  • sloc: makefile: 7
file content (71 lines) | stat: -rw-r--r-- 1,423 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# UnicodePlus

[![Build Status](https://img.shields.io/travis/nitely/nim-unicodeplus.svg?style=flat-square)](https://travis-ci.org/nitely/nim-unicodeplus)
[![licence](https://img.shields.io/github/license/nitely/nim-unicodeplus.svg?style=flat-square)](https://raw.githubusercontent.com/nitely/nim-unicodeplus/master/LICENSE)

A replacement for Nim's unicode module. It closely
follows Python's API behavior for each operation.

> Note: this is a WIP! But what's
> implemented is already ready to use.

## Install

```
nimble install unicodeplus
```

## Compatibility

Nim 0.18.0, +0.19.0

## Usage

```nim
import unicodeplus

assert "abc def ghi".isLower()
assert "ABC DEF GHI".isUpper()
assert "A Title - Yes!".isTitle()
assert "  \L".isWhiteSpace()
assert "abc123۲⅕".isAlnum()
assert "abcd".isAlpha()
assert "0123456789".isDecimal()
assert "0123456789۲".isDigit()
assert "0123456789۲⅕".isNumeric()
assert "abcd".isPrintable()
```

[docs](https://nitely.github.io/nim-unicodeplus/)

## vs Nim's stdlib

Although this library will be a replacement
for Nim's unicode module, it won't be a *drop-in replacement*.
Some of the APIs don't show the same behavior.

To illustrate:

```nim
import unicode

assert(not "A Title - Maybe?".isTitle)
assert(not "I'M UPPER?".isUpper)
```

```nim
import unicodeplus

assert "A Title - Maybe?".isTitle
assert "I'M UPPER?".isUpper
```

## Tests

```
nimble test
```

## LICENSE

MIT