Skip to main content

A lightweight code snippet management system with CLI, API, and web interface

Project description

Snipster

A lightweight, developer-friendly code snippet management system

Snipster helps developers organize, search, and manage code snippets efficiently through both a CLI and API interface. Built with FastAPI, SQLModel, and Typer.

Features

Multiple Interfaces

  • 🖥️ Command-line interface (CLI) for quick snippet management
  • 🌐 REST API for integration with other tools
  • 📊 Streamlit web interface for visual browsing

🔍 Powerful Search

  • Full-text search across titles, code, descriptions, and tags
  • Filter by programming language
  • Toggle favorites for quick access

📝 Rich Metadata

  • Support for Python, JavaScript, and TypeScript
  • Tagging system for organization
  • Automatic timestamps for creation and updates
  • Favorite snippets for quick retrieval

Installation

pip install snipster-app

Quick Start

CLI Usage

# Add a snippet
snipster add --title "Quick Sort" --code "def quicksort(arr): ..." --language Python --tags "algorithm,sorting"

# List all snippets
snipster list

# Search snippets
snipster search --term "sort" --language Python

# Get specific snippet
snipster get --snippet-id 1

# Toggle favorite
snipster favourite --snippet-id 1

# Delete snippet
snipster delete --snippet-id 1

Python API

from snipster import Language, Snippet

# Create a snippet
snippet = Snippet(
    title="Hello World",
    code="print('Hello, World!')",
    language=Language.PYTHON,
    tags="beginner,tutorial"
)

REST API

Start the API server:

# The API runs as a separate service
uvicorn snipster.api.main:app --reload

Endpoints available at http://localhost:8000/docs

Requirements

  • Python 3.13+
  • SQLite (included)

Use Cases

  • 💼 Interview Prep - Store commonly used algorithms and patterns
  • 🎓 Learning - Organize code examples from tutorials
  • 🔧 Daily Development - Quick access to utility functions and snippets
  • 📚 Team Knowledge Base - Share snippets via API

Documentation

Full documentation available at: [your-docs-url]

License

MIT License

Contributing

Contributions welcome! Visit [your-repo-url] for guidelines.

Author

Sun - [sl2902]

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

snipster_app-0.1.4.tar.gz (111.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

snipster_app-0.1.4-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

Details for the file snipster_app-0.1.4.tar.gz.

File metadata

  • Download URL: snipster_app-0.1.4.tar.gz
  • Upload date:
  • Size: 111.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.13

File hashes

Hashes for snipster_app-0.1.4.tar.gz
Algorithm Hash digest
SHA256 4abce23994a8be0d8d1f7b1233751f65f573eea08b9a69b3f170afd353c9f2d2
MD5 2e6a28bee534ea44f8c74ef923ae8683
BLAKE2b-256 7dbc3a16f3f62970c04481e2b6b9c4087c3088ffe3be162fca6302bf48f5070e

See more details on using hashes here.

File details

Details for the file snipster_app-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for snipster_app-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ea3cda9d06883369fed6855bd3c723d0efc15a3ca826d591b2b6d2e9d6ca26e8
MD5 7dcbba1b25d8c1c03d56317e2cbe5854
BLAKE2b-256 eebcead44e8631cdebf219819e7e0bed7f1f7bb9e2c183092cded9d3482eefce

See more details on using hashes here.

Supported by

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