pyngramroh 0.0.1

A python package to create ngrams.

pyngramroh

The pyngramroh package contains a python module to create ngrams.

Table of Contents

1. Introduction

Introduction

This package contains a module to create ngrams, it does not create statistics about the created ngrams. An explanation what a ngram is can be found here: ngram

Getting started

Prerequisites

• Python installed
• Operatingsystem: Linux or Windows, not tested on mac
• IDE like VS Code, if you want to contribute or change the code

Installation

There are two ways to install this module depending on the way you work and the preinstalled modules:

1. pip install pyngramroh
2. python -m pip install pyngramroh

How to use

How to import

You can import the module in two ways:

import pyngramroh

This will import all functions. Even the ones that are not supposed to be used (helper functions).

from pyngramroh import *

This will import only the significant functions, meant for using.

Using the module

Example 1:

# Import all modules from package.

from pyngramroh import *

ng = NGram("Demo",2,True)

print(ng.generate_ngram())

# Output:
# 
# ['_D', 'De', 'em', 'mo', 'o_']

# Import all modules from package.
from pyngramroh import *

ng = NGram("This is a demo string",2)

print(ng.create_ngram())

# Output:
#
# ["This_is","is_a","a_demo","demo_string"]

Releasing

Releases are published automatically when a tag is pushed to GitHub.

# Create release variable.
$Release = "x.x.x"
# Create commit.
git commit --allow-empty -m "Release $Release"
# Create tag.
git tag -a $Release -m "Version $Release"
# Push from original.
git push origin --tags
# Push from fork.
git push upstream --tags

License

MIT