Skip to main content

Process a directory of files with frontmatter and middleware

Project description

# Metalsmyth

[![Build Status](https://travis-ci.org/eyeseast/python-metalsmyth.svg)](https://travis-ci.org/eyeseast/python-metalsmyth)

This is a little library to process a directory of files with a stack of middleware. It is based on [metalsmith](http://www.metalsmith.io/), which is built in and for Node. This version uses the same three-step process:

1. Read all the files in a source directory.
2. Invoke a series of plugins that manipulate the files.
3. Write the results to a destination directory!

Each plugin is simply a callable that takes a dictionary of files, plus a `Stack` instance, and does something. It doesn't actually have to operate on (or return) the files. Each file is parsed for YAML Frontmatter, with file paths as keys (relative to the source directory).

A few plugins are included by default:

- drafts: filter out posts where `draft` is `true`
- dates: convert a date field to a Python `datetime.datetime` object
- markdown: convert post content to HTML using markdown
- bleach: run `bleach.clean` on post content
- linkify: run `bleach.linkify` on post content

## Install

$ pip install metalsmyth

By itself, Metalsmyth only needs [Python Frontmatter][fm], which itself relies on [PyYAML][]. If you want to use the bundled plugins, you'll need a few extra libraries:

$ pip install markdown # for markdown plugin
$ pip install bleach # for bleach and linkify plugins
$ pip install jinja2 # for jinja template plugin
$ pip install python-dateutil # for dates plugin

## Usage

```python
from metalsmyth import Stack
from metalsmyth.plugins.dates import Dates
from metalsmyth.plugins.markup import Bleach, Markdown

# create a stack with a source directory, destination and middleware
stack = Stack('tests/markup', 'tests/tmp',
Dates('date'),
Bleach(strip=True),
Markdown(output_format='html5')
)

# get processed files
files = stack.run()

# or build to stack.dest
stack.build()
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metalsmyth-0.1.1.tar.gz (10.6 kB view details)

Uploaded Source

File details

Details for the file metalsmyth-0.1.1.tar.gz.

File metadata

  • Download URL: metalsmyth-0.1.1.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for metalsmyth-0.1.1.tar.gz
Algorithm Hash digest
SHA256 59dc18cf005e10894f7695a159ceea035810de0f60a39fbdc7bba8c8effb8f65
MD5 a0c2ac9a3e3bd65276cc2ff06ac4e63a
BLAKE2b-256 3bc736f9949d4ae64346507caa51a857d944f990373dbbff50f050c0c71ce312

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page