bnrml 0.0.2

Be normal! (It's a string normalization framework.)

Be normal! (It’s a string normalization framework.)

Project Features

• bnrml

• a starter Click command-line application

• automated unit tests you can run with pytest

• a Sphinx documentation project

Getting Started

The project’s documentation contains a section to help you get started as a developer or user of the library.

Development Prerequisites

If you’re going to be working in the code (rather than just using the library), you’ll want a few utilities.

• GNU Make

• Pandoc

Resources

Below are some handy resource links.

• Project Documentation

• Click is a Python package for creating beautiful command line interfaces in a composable way with as little code as necessary.

• Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Geog Brandl and licnsed under the BSD license.

• pytest helps you write better programs.

• [GNU Make] is a tool which controls the generation of executables and other non-source files of a program from the program’s source files.

Authors

• Pat Daburu - Initial work - github

See also the list of contributors who participated in this project.

LicenseMIT License

Copyright (c) patdaburu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.