Metadata-Version: 2.1
Name: vell
Version: 1.0.2
Summary: Check spell for mutiple files in a project
Home-page: https://github.com/nguyencuong382/vell
Author: nguyencuong382
Author-email: nguyenmanhcuong382@gmail.com
License: MIT
Keywords: check,spell
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Requires-Dist: pyspellchecker (==0.4.0)
Requires-Dist: beautifulsoup4 (==4.7.1)

# Vell

A tool for spell checking multiple files in a folder. Sometimes when you write a document for your project but you get misspelled words you don't know

## Getting Started

### Installing

```
pip install --upgrade vell
```

### Check spell

1. Create `vell.ini` config file based on [vell.sample.ini](https://github.com/nguyencuong382/vell/vell.sample.ini)
2. Run the bello command to check spell:

```
vell
```

### Custom `vell.ini` config file

Some misspelled words like 'my_var' are your definition and they appear many time, you can ignore them by theirs frequency of appearance
In this case. I tell to vell if a word appear more than 5 times, they will be ignored

```
[spell]
level_ignore = 5
...
```

Vell checks multiple files with specific extensions. To add more type of files:

```
[spell]
...
extensions =
	.html,
        .rst,
	README.md,
...
```

Some misspelled words like _html, env_ are keywords, you can ignore them when checking

```
[spell]
...
ignore_words =
        ; code
        html

        ; environment
        env
...
```

To exclude paths you don't want vell to check spell:

```
...
[path]
exclude =
	.env,
	.vscode,
        __pycache__,
...
```


