kids.txt 0.0.2

Kids text manipulation helpers.

kids.txt is a Python library providing helpers to manage text. It’s part of ‘Kids’ (for Keep It Dead Simple) library.

It is, for now, a very humble package.

Features

using kids.txt:

• You’ll have a indent / dedent / shorten command also in python 2.

• You’ll be able to wrap text keeping the paragraph separated.

• minor helper like ucfirst function.

• produce unified diffs between 2 strings easily with udiff.

Installation

You don’t need to download the GIT version of the code as kids.txt is available on the PyPI. So you should be able to run:

pip install kids.txt

If you have downloaded the GIT sources, then you could add install the current version via traditional:

python setup.py install

And if you don’t have the GIT sources but would like to get the latest master or branch from github, you could also:

pip install git+https://github.com/0k/kids.txt

Or even select a specific revision (branch/tag/commit):

pip install git+https://github.com/0k/kids.txt@master

Usage

indent

You can easily indent text with:

>>> from __future__ import print_function
>>> from kids import txt

>>> string = 'This is first line.\nThis is second line\n'

>>> print(txt.indent(string, prefix="| "))
| This is first line.
| This is second line
|

dedent

You can also dedent text:

>>> print(txt.dedent(
...    '''This is a doc
...
...       with fancy indentation, that should just work also.
...       Without removing too much neither as:
...          - more space.'''))
This is a doc
<BLANKLINE>
with fancy indentation, that should just work also.
Without removing too much neither as:
   - more space.

paragrap_wrap

Wrap paragraph separately:

>>> string = 'This is first paragraph which is quite long don\'t you \
... think ? Well, I think so.\n\nThis is second paragraph\n'

>>> print(txt.paragraph_wrap(string))
This is first paragraph which is quite long don't you think ? Well, I
think so.
This is second paragraph

Notice that that each paragraph has been wrapped separately.

ucfirst

This function will return the given string with the first character forced to uppercase:

>>> txt.ucfirst('foo')
'Foo'

shorten

This function will truncate the given string to the given length, if necessary. It’ll replace the last 2 characters by a ‘..’ to indicate truncation:

>>> txt.shorten('fool', l=5)
'fool'
>>> txt.shorten('supercalifragilisticexpialidocious', l=5)
'sup..'

udiff

Shows the unified diff between to text:

>>> print(txt.udiff('a\n\nc', 'b\n\nc'))
--- None
+++ None
@@ -1,3 +1,3 @@
-a
+b
<BLANKLINE>
 c
<BLANKLINE>

Contributing

Any suggestion or issue is welcome. Push request are very welcome, please check out the guidelines.

Push Request Guidelines

You can send any code. I’ll look at it and will integrate it myself in the code base and leave you as the author. This process can take time and it’ll take less time if you follow the following guidelines:

• check your code with PEP8 or pylint. Try to stick to 80 columns wide.

• separate your commits per smallest concern.

• each commit should pass the tests (to allow easy bisect)

• each functionality/bugfix commit should contain the code, tests, and doc.

• prior minor commit with typographic or code cosmetic changes are very welcome. These should be tagged in their commit summary with !minor.

• the commit message should follow gitchangelog rules (check the git log to get examples)

• if the commit fixes an issue or finished the implementation of a feature, please mention it in the summary.

If you have some questions about guidelines which is not answered here, please check the current git log, you might find previous commit that would show you how to deal with your issue.

License

Copyright (c) 2015 Valentin Lab.

Licensed under the BSD License.

Changelog

0.0.2 (2015-02-04)

New

• Added udiff to get unified diffs of strings. [Valentin Lab]

• Added ucfirst and shorten. [Valentin Lab]

• Added a dedent() function. [Valentin Lab]

Fix

• indent would ignore first set to empty string. [Valentin Lab]

0.0.1 (2014-05-13)

• First import. [Valentin Lab]