Metadata-Version: 2.1
Name: augustine-text
Version: 0.1.0
Summary: UNKNOWN
Home-page: https://github.com/kajuberdut/augustine-text
Author: Patrick Shechet
Author-email: patrick.shechet@gmail.com
License: BSD
Description: <!--
        *** Thanks for checking out the Best-README-Template. If you have a suggestion
        *** that would make this better, please fork the repo and create a pull request
        *** or simply open an issue with the tag "enhancement".
        *** Thanks again! Now go create something AMAZING! :D
        ***
        ***
        ***
        *** To avoid retyping too much info. Do a search and replace for the following:
        *** kajuberdut, augustine, twitter_handle, patrick.shechet@gmail.com, augustine, String functions in pure Python
        -->
        
        
        
        <!-- PROJECT SHIELDS -->
        <!--
        *** I'm using markdown "reference style" links for readability.
        *** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
        *** See the bottom of this document for the declaration of the reference variables
        *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
        *** https://www.markdownguide.org/basic-syntax/#reference-style-links
        -->
        [![Contributors][contributors-shield]][contributors-url]
        [![Forks][forks-shield]][forks-url]
        [![Stargazers][stars-shield]][stars-url]
        [![Issues][issues-shield]][issues-url]
        [![MIT License][license-shield]][license-url]
        [![LinkedIn][linkedin-shield]][linkedin-url]
        
        
        
        <!-- PROJECT LOGO -->
        <br />
        <p align="center">
          <a href="https://github.com/kajuberdut/augustine">
            <img src="https://raw.githubusercontent.com/kajuberdut/augustine-text/master/images/icon.svg" alt="icon" width="160" height="160">
          </a>
        
          <h3 align="center">augustine</h3>
        
          <p align="center">
            Simple text generation with document training.
          </p>
        </p>
        
        
        
        <!-- TABLE OF CONTENTS -->
        <details open="open">
          <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
          <ol>
            <li>
              <a href="#about-the-project">About The Project</a>
            </li>
            <li>
              <a href="#getting-started">Getting Started</a>
            </li>
            <li><a href="#usage">Usage</a>
              <ul>
                <li><a href="#additional-documentation">Additional Documentation</a></li>
              </ul>
            </li>
            <li><a href="#roadmap">Roadmap</a></li>
            <li><a href="#contributing">Contributing</a></li>
            <li><a href="#license">License</a></li>
            <li><a href="#contact">Contact</a></li>
          </ol>
        </details>
        
        
        
        <!-- ABOUT THE PROJECT -->
        ## About The Project
        
        Augustine is a fairly simple text generation library. The name is taken from St. Augustine of Hippo, the most prolifict of early church writers.
        
        * No hard dependencies
        * 100% pure python
        * Simple
        * Works out of the box
        * Extensible to mimic specific documents
        
        
        <!-- GETTING STARTED -->
        ## Getting Started
        
        To get a local copy up and running follow these simple steps.
        
        ### Installing with pip
        
          ```sh
          pip install augustine_text
          ```
        
        For information about cloning and dev setup see: [Contributing](#Contributing)
        
        
        <!-- USAGE EXAMPLES -->
        ## Usage
        Here is an example showing basic usage.
        
        ```python
        from augustine_text.sample_text import words
        
        
        # 75K words of procedurally generated text
        # This is about the length of novel.
        text = words(75000)
        text_length = len(text)
        
        
        print(text[:100])
        ```
        
        <!-- CONTRIBUTING -->
        ## Contributing
        
        Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
        
        1. Fork the Project
        2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
        3. Add tests, we aim for 100% test coverage [Using Coverage](https://coverage.readthedocs.io/en/coverage-5.3.1/#using-coverage-py)
        4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
        5. Push to the Branch (`git push origin feature/AmazingFeature`)
        6. Open a Pull Request
        
        ### Cloning / Development setup
        1. Clone the repo and install
            ```sh
            git clone https://github.com/kajuberdut/augustine-text.git
            cd augustine
            pipenv install --dev
            ```
        2. Run tests
            ```sh
            pipenv shell
            ward
            ```
          For more about pipenv see: [Pipenv Github](https://github.com/pypa/pipenv)
        
        
        
        <!-- LICENSE -->
        ## License
        
        Distributed under the BSD Two-clause License. See `LICENSE` for more information.
        
        
        
        <!-- CONTACT -->
        ## Contact
        
        Patrick Shechet - patrick.shechet@gmail.com
        
        Project Link: [https://github.com/kajuberdut/augustine](https://github.com/kajuberdut/augustine)
        
        
        
        
        <!-- MARKDOWN LINKS & IMAGES -->
        <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
        [contributors-shield]: https://img.shields.io/github/contributors/kajuberdut/augustine.svg?style=for-the-badge
        [contributors-url]: https://github.com/kajuberdut/augustine-text/graphs/contributors
        [forks-shield]: https://img.shields.io/github/forks/kajuberdut/augustine.svg?style=for-the-badge
        [forks-url]: https://github.com/kajuberdut/augustine-text/network/members
        [stars-shield]: https://img.shields.io/github/stars/kajuberdut/augustine.svg?style=for-the-badge
        [stars-url]: https://github.com/kajuberdut/augustine-text/stargazers
        [issues-shield]: https://img.shields.io/github/issues/kajuberdut/augustine.svg?style=for-the-badge
        [issues-url]: https://github.com/kajuberdut/augustine-text/issues
        [license-shield]: https://img.shields.io/badge/License-BSD%202--Clause-orange.svg?style=for-the-badge
        [license-url]: https://github.com/kajuberdut/augustine-text/blob/main/LICENSE
        [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
        [linkedin-url]: https://www.linkedin.com/in/patrick-shechet
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Description-Content-Type: text/markdown
