Metadata-Version: 2.1
Name: tumbleweed
Version: 1.0.2
Summary: A lightweight, easy-to-setup blog framework built on Flask
Project-URL: Homepage, https://github.com/emilkovacev/tumbleweed
Author-email: Emil Kovacev <emilkovacev@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2022, Emil Kovacev
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: flask
Description-Content-Type: text/markdown

# tumbleweed

*A simple framework for all your blogging needs*

### Setup

1. Initialize the blog object

```
blog = td.Blog(
        title="The Burger Historian",
        description="Brief snippets of the origin of my favorite food",
        author="Daniel"
        )
```


2. Add a post to your blog. *Notice that markdown and inline html is fully supported!*

```
blog.add('Why Vim is better than Emacs', 
    """
    1. Because I say so
    2. My hands are **too small** to type C-y
    3. Refer to item 1
    """
)
```

3. Run your app

```
blog.run(port=8000)
```

### Details

The `Blog` object inherits the default Flask object, so you can use any default
flask options to start the server
