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.2.tar.gz (112.7 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.2-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for snipster_app-0.1.2.tar.gz
Algorithm Hash digest
SHA256 12959391d63d8c8e984a3c7c0f8884a489ddecaa8aafbfcb8086c2a6b33d7b81
MD5 455c4f3f84996d1816157fe3b18e2df9
BLAKE2b-256 c08c08b206c5aacf7685336c52cc71ceae0d0eabc7090196336fe796867411a1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snipster_app-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4bff1c850a531044f3cba7ac7134a4e220964f22665ea4a2b8d6bec9bb8187f4
MD5 273fd3dd2f7dd53b4449667bf1e07a6a
BLAKE2b-256 1fe84f227477d4a0652eb52967d4a231378386e77d01e1d75f1e78ad4530dfc8

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