GithubHelp home page GithubHelp logo

clipper's Introduction

Clipper

A tool for accessing code snippets contained in a folder of plain text Markdown files. This is a python reimplementation of snibbets

This is, for the most part, api compatible with snibbets. The config file is the same format, the command line arguments are identical. There are minor differences, documented below.

For further documentation, reference the snibbets docs (at least until I get around to adding them here).

Install

Currently only installation from git is supported:

python -m pip install git+https://github.com/borzilleri/clipper.git

Todo List

These are features that snibbets has that I have not yet implemented, or additional features I'd like to add. They're very roughly in priority order.

  • Alfred support: IN PROGRESS/Mostly done.

    This should be nearly functionally complete and usable. Remaining tasks are improved documentation in the configuration window, and removing "nulls" from some of the displayed fields.

  • Improved Output Redirection

    Better checking that our output is a tty when prompting for menus.

  • Documentation

    Properly document options, usage, installation, etc, here instead of relying relying on the snibbets docs.

  • Release to PyPi

  • skylighting highlighter support

    Low priority. pygments is built in and works pretty well.

  • LaunchBar support

    Low priority. I don't use LaunchBar myself, so I'm not as inclined to get this to work.

Differences from snibbets

  • copy behavior

    When multiple snippets are printed (by specifying --all or selecting All Snippets from the menu), the entire output will be copied, not just the last snippet's code.

  • pygments highlighting

    Pygments is available as a python module, and as such is bundled with clipper. This means there's no need to install it separately, and it's always available as the default highlighter.

  • console menu

    The default ("console") menu is powered by the pick library.

  • Minor formatting differences

    I have attempted to maintain compatability for the config file, command-line options, and snippet files. However, the code is not exactly the same, and I have made some opinionated choices around format and whitespace. The result is that the output format may differ slightly.

Ok, but why did I make this?

Honestly? No good reason. Stretching some codeing muscles, learning more about building and publishing python packages.

Also, I just don't care for ruby and didnt feel like installing it.

Credits & Attribution

Ship icon created by Ahmad Yafie - Flaticon

clipper's People

Contributors

borzilleri avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.