snippy

Snippy is a software development and maintenance notes manager.


Keywords
notes, markdown, yaml, text, command-line, cli, server, backend, docker, software-engineering
Licenses
AGPL-3.0/GPL-3.0+
Install
pip install snippy==0.10.0

Documentation

badge-pypiv badge-pys badge-pyv badge-cov badge-docs badge-build badge-docker

Snippy

I can't remember how - I just remember what.

Snippy is a software development and maintenance notes manager. It allows organizing and sharing examples and solutions from self hosted or shared storage through command line interface or via REST API server. Snippy may be able to help you for example when working with different open source components that all have different commands, settings and issues.

Features

Main features include:

  • Use from Linux command line or from a REST API server as in Heroku example.
  • Run with a self-hosted SQLite or shared PostgreSQL database.
  • Manage notes in three categories: snippets, solutions and references.
  • Supports Markdown, YAML, JSON and text formats.
  • Organize notes with metadata like groups, tags and links.

Installation

To install as a tool, run:

pip install snippy --user

To install as a server, run:

docker pull docker.io/heilaaks/snippy:latest

Usage

Snippy in action!

Contributing

This is a personal hobby project to try to organize maintenance notes when working with large software projects. Author is happy to hear if this project has been actually used by anyone. Please post bug reports of feature requests through GitLab issues.

This project got inspiration from the Buku.

Related work