An open API service indexing awesome lists of open source software.

https://github.com/theabhijeet/lorem_text

Dummy lorem ipsum text generator for Python.
https://github.com/theabhijeet/lorem_text

cli hacktoberfest hacktoberfest-accepted lorem-ipsum lorem-ipsum-generator python

Last synced: 11 months ago
JSON representation

Dummy lorem ipsum text generator for Python.

Awesome Lists containing this project

README

          

==========
Lorem Text
==========

.. image:: https://img.shields.io/pypi/dm/lorem_text

.. image:: https://img.shields.io/pypi/pyversions/lorem_text

Dummy lorem ipsum text generator

* Free software: MIT license
* Documentation: https://lorem-text.readthedocs.io.

Features
--------
Dummy lorem ipsum text generator for Python.

* Generate dummy senetnce, paragraphs and words.
* Command line interface tool included.

=====
Usage
=====

To install Lorem Text, run this command in your terminal::

pip install lorem-text

To use Lorem Text in a project::

from lorem_text import lorem

For randomly generated sentence of lorem ipsum text where the first word is capitalized, and the sentence ends in either a period or question mark::

lorem.sentence()

Generate a single paragraph::

lorem.paragraph()

Generate multiple paragraphs of lorem ipsum text each paragraph's consists of 2 to 4 sentences::

paragraph_length = 5
lorem.paragraphs(paragraph_length)

Generate random lorem ipsum words seperated with single space::

words = 10
lorem.words(words)

Command Line Interface
----------------------

For randomly generated paragraph of lorem ipsum text::

lorem_text

Lorem ipsum sentence::

lorem_text --s

Lorem ipsum words::

lorem_text --words=50

============
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage