Metadata-Version: 2.1
Name: blog
Version: 1.0.0
Summary: A static website generator
Home-page: https://github.com/tomleo/blog
Author: Tom Leo
Author-email: tom@tomleo.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/tomleo/blog/issues
Project-URL: Funding, https://donate.pypi.org
Project-URL: Source, https://github.com/tomleo/blog/
Keywords: static website generator
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.7.*
Description-Content-Type: text/markdown
Requires-Dist: PyYAML (>=5.1.*)
Requires-Dist: Jinja2 (>=2.10.*)
Requires-Dist: Markdown (>=3.1.*)
Requires-Dist: Pygments (>=2.4.*)
Requires-Dist: pymdown-extensions (>=6.*)
Requires-Dist: pyembed-markdown (>=1.1.*)
Requires-Dist: docopt (>=0.6.*)
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

# Blog

This is a simple static site generator. It traverses through a source directory of markdown files and creates a
destination directory with equivalent HTML files.

```
Markdown In -> HTML Out
```

---

[![PyPI](hhttps://img.shields.io/pypi/v/blog.svg)](https://pypi.python.org/pypi/blog)
[![PyPI](hhttps://img.shields.io/pypi/dm/blog.svg)](https://pypi.python.org/pypi/blog)

---

## Installation

```
$ python3.7 -m venv venv
$ source venv/bin/activate
$ pip install blog
```

## Usage

```
(venv) $ python -m blog build /path/to/source-dir /path/to/build-dir
```

## Simple by design

- Nothing smart is done around friendly URLs / generating folders with `index.html` files
    + If you want an `index.html` file, create an `index.md` file in your source directory
- There is no database
- There is no configuration (for now)

**Need something more complex?**

- Consider using Hugo, Gatsby, Django, writing your own server


