Skip to main content

Turn snippets of code into beautiful images.

Project description

sniped

sniped is a CLI tool that helps you turn code snippets into beautiful images.

Example

sniped create snappify "print('Hello, world!')" --language Python --key snappify.key --out imgs/hello_world.png

Usage

$ sniped [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • config: Manage the configuration for the services.
  • create: Create a beautiful image from a snippet of code.

sniped config

Manage the configuration for the services.

Usage:

$ sniped config [options] SERVICE:[carbon|snappify]

Arguments:

  • SERVICE:[carbon|snappify]: [required]

Options:

  • --show / --no-show: Print the configuration to stdout. [default: False]
  • --pretty / --no-pretty: Whether to use pretty printing or show plain output. [default: True]
  • --write WRITE_PATH: File to write default config to.
  • --help: Show this message and exit.

sniped create

Create a beautiful image from a snippet of code.

Usage:

$ sniped create [options] SERVICE:[carbon|snappify] CODE_OR_PATH

Arguments:

  • SERVICE:[carbon|snappify]: [required]
  • CODE_OR_PATH: Code to include in the image or path to code file. Use '-' to read from stdin. [required]

Options:

  • --language LANG: Language for syntax highlighting; 'auto' only works for carbon. [default: auto]
  • --key KEY_OR_PATH: (Path to file with) API key for Snappify.
  • --out PATH: Write to given file instead of stdout.
  • --theme THEME: Theme to use for syntax highlighting.
  • --help: Show this message and exit.

Changelog

See the file CHANGELOG.md.

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

sniped-1.2.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

sniped-1.2.0-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file sniped-1.2.0.tar.gz.

File metadata

  • Download URL: sniped-1.2.0.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.7 Windows/10

File hashes

Hashes for sniped-1.2.0.tar.gz
Algorithm Hash digest
SHA256 93fe85fc35977014fb0edd1a1e48bfeb8ef9e6c862431140e0034f29c1339631
MD5 722b997b09c9c3080bb68d0d6934fd4c
BLAKE2b-256 0f55fcb464ddcbd7c98c983df7b299c2e727864f4df098b319dbe43a6b0aa913

See more details on using hashes here.

File details

Details for the file sniped-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: sniped-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.7 Windows/10

File hashes

Hashes for sniped-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eecd8c446e640c37593bd23fc8deb10003885dc1dc18d0d4d39dd7c3406483fd
MD5 37c9f0fc4d4ec483bbad145cca7d87eb
BLAKE2b-256 9134c96b382557d62b6641116fb7ed9177bc60bdbab872f02adb1785cef1b820

See more details on using hashes here.

Supported by

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