A python module for cutting strings.
Project description
pycutroh
The pycutroh module is a simple string cutting module.
Table of contents
Introduction
I've written this module to learn python and some python basics like using unittests, imports and how python modules/packets work.
This module is inspired by the linux bash command.
At the moment this module provides four functions, which can be used to manipulate strings. For further information see here: How to use
The cli interface for this module is now available.
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:
pip install pycutroh
python -m pip install pycutroh
How to use
How to Import
You can import the module in two ways:
import pycutroh
- This will import all functions. Even the ones that are not supposed to be used (helper functions).
from pycutroh import *
- This will import only the significant functions, meant for using.
Using the module
Depending on the way you imported the module, the following examples look a bit different.
Example 1:
from pycutroh import *
print(get_letter_on_pos("This is a demonstration string.",0))
Result:
T
Example 2:
from pycutroh import *
print(get_letters_from_pos_to_pos("This is a demonstration string.",(0,4)))
Result:
This
Example 3:
from pycutroh import *
print(get_fields("This is a demonstration string.",(0,3)," "))
Result:
This demonstration
Example 4:
import pycutroh
print(pycutroh.get_fields_new_separator("This is a demonstration string.",(0,3)," ","|"))
Result:
This|demonstration
Using the cli
You can now use the cli of the pycutroh module. This cli is my first using the argparse module, so there might be adjustments in the future.
To show the help run the following command:
python -m pycutroh -h
Result:
usage: __main__.py [-h] [-s STRING] [-glop GETLETTERONPOS | -glbp GETLETTERSFROMPOSTOPOS GETLETTERSFROMPOSTOPOS] {f} ...
positional arguments:
{f} Get fields separated by specified delimiter.
f Get fields by delimiter and join using same delimiter.
options:
-h, --help show this help message and exit
-s STRING, --string STRING
-glop GETLETTERONPOS, --getLetterOnPos GETLETTERONPOS
Letter on position to return.
-glbp GETLETTERSFROMPOSTOPOS GETLETTERSFROMPOSTOPOS, --getLettersFromPosToPos GETLETTERSFROMPOSTOPOS GETLETTERSFROMPOSTOPOS
Get letter between positions.
Using a function:
python -m pycutroh f --getFields (0,1,2,3) --delimiter " " --newDelimiter ","
Result:
This,is,a,demonstration
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.