Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

A small cli tool to filter plain text files by header tags.

Project description

A simple CLI tool to filter and list .md files based on comment headers.

Motivation

After testing multiple sophisticated tools to document small ideas or meetups, I found plain .md files and a flat directory structure to work best for me. I have built this tool to help me search these protocols in the terminal.

The cli tool ptag scans a given directory for .md files and tries to extract a block comment at the start. If this comment includes valid yaml, the file is considered valid. One can specify selectors to further filter all valid files. The list of results is then printed to stdout.

Example

Consider the file ~/protocols/example.md:

<!--
author:
  - jan
  - olli
tag:
  - idea
  - python
-->

# Heading

Some text.

One can filter the ~/protocols directory using the cli tool ptag. The following command would return the above created filename.

ptag -t idea,python -a jan ~/protocols

This is equivalent to

cd ~/protocols
ptag -t idea,python -a jan

Project details


Download files

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

Files for prototag, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size prototag-0.1.0-py2.py3-none-any.whl (10.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size prototag-0.1.0.tar.gz (7.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page