<commit_before># easyroman

####A easy Integer into Roman numerals converter library.
===

### Knowledge Algorithm

1. Roman numerals 
2. Context free grammar
3. The roman numerals logic can be express by Context free grammar.
4. Documents in modual doc and following links as Reference:
	a. [WIKI of Roman Numberls](http://en.wikipedia.org/wiki/Roman_numerals)
    b. [WIKI of Context Free Grammer](http://en.wikipedia.org/wiki/Context-free_grammar)
    c. [Roman Numbers into Context free grammar](http://www.cs.bath.ac.uk/~occ/comp0029/roman_numerals.shtml)
    
### Install
```
unzip easyroman.zip
cd easyroman
python setup install

```


### Usages
```
import easyroman
easyroman.to_roman(12)    ## return 'XII'
easyroman.to_roman(3999)  ## return 'MMMCMXCIX'

```

### Limits

Roman numerals, as used today, are based on seven standard symbols.

| Symbol   |      Value    |
|----------|:-------------:|
|I 	|1|
|V 	|5|
|X 	|10|<commit_msg>A easy Integer into Roman numerals converter, readme update, the reason of max value.<commit_after># easyroman

####A easy Integer into Roman numerals converter library.
===

### Knowledge Algorithm

1. Roman numerals 
2. Context free grammar
3. The roman numerals logic can be express by Context free grammar.
4. Documents in modual doc and following links as Reference:
	1. [WIKI of Roman Numberls](http://en.wikipedia.org/wiki/Roman_numerals)
	
    2. [WIKI of Context Free Grammer](http://en.wikipedia.org/wiki/Context-free_grammar)
    
    3. [Roman Numbers into Context free grammar](http://www.cs.bath.ac.uk/~occ/comp0029/roman_numerals.shtml)
    
### Install
```
unzip easyroman.zip
cd easyroman
python setup install

```


### Usages
```
import easyroman
easyroman.to_roman(12)    ## return 'XII'
easyroman.to_roman(3999)  ## return 'MMMCMXCIX'

```

### Limits

Roman numerals, as used today, are based on seven standard symbols.

| Symbol   |      Value    |
|----------|:-------------:|
|I 	|1|
|V 	|5|
|X 	|10|
{'fraction_non_alphanumeric': 0.14561136478944697, 'fraction_numerical': 0.0197869101978691, 'mean_word_length': 3.4414414414414414, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1932002', 'n_tokens_mistral': 717, 'n_tokens_neox': 662, 'n_words': 204}