augustine-text 0.1.0

augustine

Simple text generation with document training.

Table of Contents

1. About The Project
2. Getting Started
3. Usage
   • Additional Documentation
4. Roadmap
5. Contributing
6. License
7. Contact

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

To get a local copy up and running follow these simple steps.

Installing with pip

pip install augustine_text

For information about cloning and dev setup see: Contributing

Usage

Here is an example showing basic usage.

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

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
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

   git clone https://github.com/kajuberdut/augustine-text.git
   cd augustine
   pipenv install --dev
   

2. Run tests

   pipenv shell
   ward
   

For more about pipenv see: Pipenv Github

License

Distributed under the BSD Two-clause License. See LICENSE for more information.

Contact

Patrick Shechet - patrick.shechet@gmail.com

Project Link: https://github.com/kajuberdut/augustine