Skip to main content

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

Project description

Prototag

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.

Installation

pip install prototag

Synopsis

Usage: ptag [options] [<dir>]

-h, --help Show help.
-v, --version Show version.
-t <selector>, --tag <selector>
 Filter the files by tags by specifying a selector.
-a <selector>, --author <selector>
 Filter the files by their author by specifying a selector.

One can use logical AND and OR conditions to filter the found files with valid headers. AND terms are combined using ‘,’ and OR terms are combined using ‘:’. OR terms are evaluated before AND terms. The OR conditions are not exclusive.

Select all files, that have both tag1 and tag2.

ptag -t tag1,tag2

Select all files, that have at least one of both tags.

ptag -t tag1:tag2

Select all files, that have either tag1 and tag2 or tag3 or both.

ptag -t tag1,tag2:tag3

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 filename of the above created file.

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

The directory is optional and defaults to the current working directory. This is therefore equivalent to

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

Changelog

0.1.1 (2017-12-23)

  • Add CHANGELOG.rst.
  • Update README.rst.

0.1.0 (2017-12-22)

  • Initial release.

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.1
Filename, size File type Python version Upload date Hashes
Filename, size prototag-0.1.1-py2.py3-none-any.whl (7.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size prototag-0.1.1.tar.gz (7.9 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