Skip to main content

An ASCII banner comment generator for making subl nicer.

Project description

[![Build Status](https://travis-ci.org/jbn/banner_comment.svg?branch=master)](https://travis-ci.org/jbn/banner_comment)
[![Coverage Status](https://coveralls.io/repos/github/jbn/banner_comment/badge.svg?branch=master)](https://coveralls.io/github/jbn/banner_comment?branch=master)
<!-- LOL: Coverage on a one function module -->

# What is this?

I like banner comments in my code. Modern IDE's have fancier ways of doing this like code collapsing and such. And, Python style guides generally prohibit this style of commenting. But, I like to see the big test while scrolling (or, in [`subl`](https://www.sublimetext.com/)).

# Example

Running this:

```python
from banner_comment import *
banner_comment("hello")
```

Prints:

```
###############################################################################
# _ _ _ #
# | |__ ___| | | ___ #
# | '_ \ / _ \ | |/ _ \ #
# | | | | __/ | | (_) | #
# |_| |_|\___|_|_|\___/ #
# #
###############################################################################
```

The package also installs a command line entry point, allowing:

```bash
banner_comment "hello"
```

# Installation

This (one function) package just wraps [figlet](http://www.figlet.org/). You need to install figlet first. It exists on lots of package managers. E.g.

```sh
brew install figlet # for OSX
apt-get install figlet # for ubuntu
```

After installing figlet, do
```sh
pip install banner_comment
```

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

banner_comment-0.0.4.tar.gz (2.6 kB view details)

Uploaded Source

Supported by

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