Metadata-Version: 2.1
Name: python-lorem
Version: 1.1.0
Summary: Lorem ipsum generator.
Home-page: https://github.com/JarryShaw/lorem
Author: Jarry Shaw
Author-email: jarryshaw@icloud.com
Maintainer: Jarry Shaw
Maintainer-email: jarryshaw@icloud.com
License: BSD License
Download-URL: https://github.com/JarryShaw/lorem/archive/v1.1.0.tar.gz
Description: Lorem ipsum generator.
        
        In publishing and graphic design, lorem ipsum is a placeholder text commonly
        used to demonstrate the visual form of a document or a typeface without
        relying on meaningful content.
        
        The `lorem` module provides a generic access to generating the lorem ipsum text
        from its very original text:
        
        > Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
        > tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
        > veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
        > commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit
        > esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
        > cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
        > est laborum.
        
        Usage of the `lorem` module is rather simple. Depending on your needs, the
        `lorem` module provides generation of **word**s, **sentence**s, and
        **paragraph**s.
        
        Get Random Words
        ----------------
        
        The `lorem` module provides two different ways for getting random words.
        
        1. `word` -- generate a list of random words
        
           ```python
           word(count=1, func=None, args=[], kwargs={}) -> Iterable[str]
           ```
        
        2. `get_word` -- return random words
        
           ```python
           get_word(count=1, sep=' ', func=None, args=[], kwargs={}) -> str
           ```
        
        Get Random Sentences
        --------------------
        
        The `lorem` module provides two different ways for getting random sentences.
        
        1. `sentence` -- generate a list of random sentences
        
           ```python
           sentence(count=1, comma=(0, 2), word_range=(4, 8)) -> Iterable[str]
           ```
        
        2. `get_sentence` -- return random sentences
        
           ```python
           get_sentence(count=1, comma=(0, 2), word_range=(4, 8), sep=' ') -> Union[str]
           ```
        
        Get Random Paragraphs
        ---------------------
        
        The `lorem` module provides two different ways for getting random paragraphs.
        
        1. `paragraph` -- generate a list of random paragraphs
        
           ```python
           paragraph(count=1, comma=(0, 2), word_range=(4, 8), sentence_range=(5, 10)) -> Iterable[str]
           ```
        
        2. `get_paragraph` -- return random paragraphs
        
           ```python
           get_paragraph(count=1, comma=(0, 2), word_range=(4, 8), sentence_range=(5, 10), sep=os.linesep) -> Union[str]
           ```
        
        Customise Word Pool
        -------------------
        
        If wanted, the `lorem` module also provides an interface to customise the word
        pool as you wish.
        
        1. `set_pool` -- customise random word pool
        
           ```python
           set_pool(pool)
           ```
        
        
Keywords: lorem,loremipsum
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Obsoletes: lorem
Obsoletes: loremipsum
Requires-Python: >=3.5
Description-Content-Type: text/markdown
