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.5.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.5-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: snipster_app-0.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 c7c6ef94d1809f2f6aa0ddaa00a1fb450234b309ab80626d87cf1ba3a5efd686
MD5 1790d7c58dc16b169b729614d3fd13b3
BLAKE2b-256 981dfbe25dee94c2f82325ebb919cb18a713ff23bd0070815137b3ac1e21270c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snipster_app-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4ee9d132e1800feccc70d7d00a108e89235b48aa2bd0e9bd374adb3eec42140f
MD5 f7088446bac36859a2c6494f25eb4b02
BLAKE2b-256 09e8482fd4277d4b163947112930110312739857849c0851e811944bd0f76abd

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