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

Uploaded Python 3

File details

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

File metadata

  • Download URL: snipster_app-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 f4c9f2733dd31245b3cd58addd7dd1ec2ab931f7534658c3b270b86d809764cf
MD5 1e44f35215f833d998b11ff243089fb7
BLAKE2b-256 872011d71672fec22f1e5e740eaeaeaa7b81b2a06248cc2d404cbfea22aac41f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snipster_app-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3853a9a9823a4dbc854caa9b6f2be1721569b61e29ae15480426aec4be094f7a
MD5 3638a28e5e0ebeb2f3416131825d6b71
BLAKE2b-256 a192c261102cb09e4c0f415f4d4aaefe600e5894fda6199239a5edd98e2fb8f8

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