snippy

Snippy is a software development and maintenance notes manager.

https://github.com/heilaaks/snippy

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
○
.zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.6%) to scientific vocabulary

Keywords

backend cli command-line docker markdown notes server software-engineering text yaml

Last synced: 6 months ago · JSON representation

Repository

Snippy is a software development and maintenance notes manager.

Basic Info

Host: GitHub
Owner: heilaaks
License: other
Language: Python
Default Branch: master
Homepage:
Size: 5.24 MB

Statistics

Stars: 7
Watchers: 1
Forks: 2
Open Issues: 13
Releases: 8

Topics

backend cli command-line docker markdown notes server software-engineering text yaml

Created over 8 years ago · Last pushed 11 months ago

Metadata Files

Readme Changelog Contributing License

README.rst

|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.
- Write import plugins like `snippy-tldr`_.

Installation
============

To install as a tool, run:

.. code:: text

    pip install snippy --user

To install as a server, run:

.. code:: text

    docker pull docker.io/heilaaks/snippy:latest

Usage
=====

.. image:: https://asciinema.org/a/cssisV5qtLlaxeYORblrEf7YL.png
    :target: https://asciinema.org/a/cssisV5qtLlaxeYORblrEf7YL
    :alt: 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
============

- `tldr `_
- `cheat `_
- `Buku `_
- `CRUD in 2 minutes `_


.. |badge-pypiv| image:: https://img.shields.io/pypi/v/snippy.svg
   :target: https://pypi.python.org/pypi/snippy

.. |badge-pys| image:: https://img.shields.io/pypi/status/snippy.svg
   :target: https://pypi.python.org/pypi/snippy

.. |badge-pyv| image:: https://img.shields.io/pypi/pyversions/snippy.svg
   :target: https://pypi.python.org/pypi/snippy

.. |badge-cov| image:: https://codecov.io/gh/heilaaks/snippy/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/heilaaks/snippy

.. |badge-docs| image:: https://readthedocs.org/projects/snippy/badge/?version=latest
   :target: http://snippy.readthedocs.io/en/latest/?badge=latest

.. |badge-build| image:: https://travis-ci.org/heilaaks/snippy.svg?branch=master
   :target: https://travis-ci.org/heilaaks/snippy

.. |badge-pyup| image:: https://pyup.io/repos/github/heilaaks/snippy/shield.svg
   :target: https://pyup.io/repos/github/heilaaks/snippy/

.. |badge-docker| image:: https://images.microbadger.com/badges/image/heilaaks/snippy.svg
   :target: https://hub.docker.com/r/heilaaks/snippy

.. _REST API server: https://app.swaggerhub.com/apis/heilaaks/snippy/0.11.0

.. _development: https://snippy.readthedocs.io/en/latest/development.html

.. _Heroku example: https://snippy-server.herokuapp.com/api/snippets?sall=docker&limit=5

.. _snippy-tldr: https://github.com/heilaaks/snippy-tldr

GitHub Events

Total

Push event: 1
Pull request event: 1
Create event: 1

Last Year

Push event: 1
Pull request event: 1
Create event: 1

Committers

Last synced: almost 3 years ago

All Time

Total Commits: 1,734
Total Committers: 2
Avg Commits per committer: 867.0
Development Distribution Score (DDS): 0.002

Top Committers

Name	Email	Commits
Heikki Laaksonen	l**j@g**m	1,731
heilaaks	h**s@u**m	3

Issues and Pull Requests

Last synced: 8 months ago

All Time

Total issues: 1
Total pull requests: 10
Average time to close issues: 23 minutes
Average time to close pull requests: 3 days
Total issue authors: 1
Total pull request authors: 3
Average comments per issue: 0.0
Average comments per pull request: 0.6
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 6

Past Year

Issues: 0
Pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

pyup-bot (1)

Pull Request Authors

heilaaks (6)
dependabot[bot] (6)
fossabot (1)

Top Labels

Issue Labels

Pull Request Labels

dependencies (6)

Packages

Total packages: 1
Total downloads:
- pypi 73 last-month

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 8
Total maintainers: 1

pypi.org: snippy

Snippy is a software development and maintenance notes manager.

Homepage: https://github.com/heilaaks/snippy
Documentation: https://snippy.readthedocs.io/
License: GNU Affero General Public License v3.0 or later
Latest release: 0.11.0
published almost 6 years ago

Versions: 8
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 73 Last month

Rankings

Dependent packages count: 10.0%

Forks count: 19.1%

Stargazers count: 20.3%

Dependent repos count: 21.7%

Average: 21.9%

Downloads: 38.4%

Maintainers (1)

heilaaks

Last synced: 6 months ago

Dependencies

Pipfile pypi

bandit ==1.6.2 develop
docker ==4.2.0 develop
flake8 ==3.7.9 develop
logging-tree ==1.8.1 develop
mock ==4.0.2 develop
openapi2jsonschema ==0.9.1 develop
pprintpp ==0.4.0 develop
pyflakes ==2.1.1 develop
pylint ==2.4.4 develop
pytest ==5.4.1 develop
pytest-cov ==2.8.1 develop
pytest-mock ==3.1.0 develop
pytest-xdist ==1.32.0 develop
requests * develop
sphinx ==3.0.3 develop
sphinx-autobuild ==0.7.1 develop
sphinx-rtd-theme ==0.4.3 develop
sphinxcontrib-openapi ==0.6.0 develop
tox ==3.15.0 develop
colorama *
falcon ==2.0.0
gunicorn ==20.0.4
jsonschema ==3.2.0
psycopg2 *
pyyaml *

Pipfile.lock pypi

alabaster ==0.7.12 develop
apipkg ==1.5 develop
appdirs ==1.4.3 develop
argh ==0.26.2 develop
astroid ==2.3.3 develop
attrs ==19.3.0 develop
babel ==2.8.0 develop
bandit ==1.6.2 develop
certifi ==2020.4.5.1 develop
chardet ==3.0.4 develop
click ==7.1.2 develop
colorama ==0.4.3 develop
coverage ==5.1 develop
distlib ==0.3.0 develop
docker ==4.2.0 develop
docutils ==0.16 develop
entrypoints ==0.3 develop
execnet ==1.7.1 develop
filelock ==3.0.12 develop
flake8 ==3.7.9 develop
gitdb ==4.0.4 develop
gitpython ==3.1.1 develop
idna ==2.9 develop
imagesize ==1.2.0 develop
importlib-metadata ==1.6.0 develop
isort ==4.3.21 develop
jinja2 ==2.11.2 develop
jsonref ==0.2 develop
jsonschema ==3.2.0 develop
lazy-object-proxy ==1.4.3 develop
livereload ==2.6.1 develop
logging-tree ==1.8.1 develop
markupsafe ==1.1.1 develop
mccabe ==0.6.1 develop
mock ==4.0.2 develop
more-itertools ==8.2.0 develop
openapi2jsonschema ==0.9.1 develop
packaging ==20.3 develop
pathtools ==0.1.2 develop
pbr ==5.4.5 develop
pluggy ==0.13.1 develop
port-for ==0.3.1 develop
pprintpp ==0.4.0 develop
py ==1.8.1 develop
pycodestyle ==2.5.0 develop
pyflakes ==2.1.1 develop
pygments ==2.6.1 develop
pylint ==2.4.4 develop
pyparsing ==2.4.7 develop
pyrsistent ==0.16.0 develop
pytest ==5.4.1 develop
pytest-cov ==2.8.1 develop
pytest-forked ==1.1.3 develop
pytest-mock ==3.1.0 develop
pytest-xdist ==1.32.0 develop
pytz ==2020.1 develop
pyyaml ==5.3.1 develop
requests ==2.23.0 develop
six ==1.14.0 develop
smmap ==3.0.2 develop
snowballstemmer ==2.0.0 develop
sphinx ==3.0.3 develop
sphinx-autobuild ==0.7.1 develop
sphinx-rtd-theme ==0.4.3 develop
sphinxcontrib-applehelp ==1.0.2 develop
sphinxcontrib-devhelp ==1.0.2 develop
sphinxcontrib-htmlhelp ==1.0.3 develop
sphinxcontrib-httpdomain ==1.7.0 develop
sphinxcontrib-jsmath ==1.0.1 develop
sphinxcontrib-openapi ==0.6.0 develop
sphinxcontrib-qthelp ==1.0.3 develop
sphinxcontrib-serializinghtml ==1.1.4 develop
stevedore ==1.32.0 develop
toml ==0.10.0 develop
tornado ==6.0.4 develop
tox ==3.15.0 develop
typed-ast ==1.4.1 develop
urllib3 ==1.25.9 develop
virtualenv ==20.0.20 develop
watchdog ==0.10.2 develop
wcwidth ==0.1.9 develop
websocket-client ==0.57.0 develop
wrapt ==1.11.2 develop
zipp ==3.1.0 develop
attrs ==19.3.0
colorama ==0.4.3
falcon ==2.0.0
gunicorn ==20.0.4
importlib-metadata ==1.6.0
jsonschema ==3.2.0
psycopg2 ==2.8.5
pyrsistent ==0.16.0
pyyaml ==5.3.1
six ==1.14.0
zipp ==3.1.0

requirements.txt pypi

colorama *
falcon ==2.0.0
gunicorn ==20.0.4
importlib_metadata *
jsonschema ==3.2.0
psycopg2 ==2.8.4
pyyaml *

Dockerfile docker

alpine 3.11.3 build

pyproject.toml pypi

setup.py pypi

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

snippy

Science Score: 13.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.rst

GitHub Events

Total

Last Year

Committers

All Time

Top Committers

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: snippy

Rankings

Maintainers (1)

Dependencies