diff --git a/docs/assets/images/outputs/draw/dimensions/zima-h32.webp b/docs/assets/images/outputs/draw/dimensions/zima-h32.webp new file mode 100644 index 0000000..74b5a12 Binary files /dev/null and b/docs/assets/images/outputs/draw/dimensions/zima-h32.webp differ diff --git a/docs/assets/images/outputs/draw/dimensions/zima-term-h.webp b/docs/assets/images/outputs/draw/dimensions/zima-term-h.webp new file mode 100644 index 0000000..469863b Binary files /dev/null and b/docs/assets/images/outputs/draw/dimensions/zima-term-h.webp differ diff --git a/docs/assets/images/outputs/draw/dimensions/zima-term-w.webp b/docs/assets/images/outputs/draw/dimensions/zima-term-w.webp new file mode 100644 index 0000000..7a4337c Binary files /dev/null and b/docs/assets/images/outputs/draw/dimensions/zima-term-w.webp differ diff --git a/docs/assets/images/outputs/draw/dimensions/zima-w32.webp b/docs/assets/images/outputs/draw/dimensions/zima-w32.webp new file mode 100644 index 0000000..2d368dd Binary files /dev/null and b/docs/assets/images/outputs/draw/dimensions/zima-w32.webp differ diff --git a/docs/assets/images/outputs/draw/resample/starry-night-resample-bicubic.webp b/docs/assets/images/outputs/draw/resample/starry-night-resample-bicubic.webp new file mode 100644 index 0000000..fc1b7d9 Binary files /dev/null and b/docs/assets/images/outputs/draw/resample/starry-night-resample-bicubic.webp differ diff --git a/docs/assets/images/outputs/draw/resample/starry-night-resample-bilinear.webp b/docs/assets/images/outputs/draw/resample/starry-night-resample-bilinear.webp new file mode 100644 index 0000000..83a03b6 Binary files /dev/null and b/docs/assets/images/outputs/draw/resample/starry-night-resample-bilinear.webp differ diff --git a/docs/assets/images/outputs/draw/resample/starry-night-resample-box.webp b/docs/assets/images/outputs/draw/resample/starry-night-resample-box.webp new file mode 100644 index 0000000..a33bc2e Binary files /dev/null and b/docs/assets/images/outputs/draw/resample/starry-night-resample-box.webp differ diff --git a/docs/assets/images/outputs/draw/resample/starry-night-resample-hamming.webp b/docs/assets/images/outputs/draw/resample/starry-night-resample-hamming.webp new file mode 100644 index 0000000..e9428a0 Binary files /dev/null and b/docs/assets/images/outputs/draw/resample/starry-night-resample-hamming.webp differ diff --git a/docs/assets/images/outputs/draw/resample/starry-night-resample-lanczos.webp b/docs/assets/images/outputs/draw/resample/starry-night-resample-lanczos.webp new file mode 100644 index 0000000..157f93c Binary files /dev/null and b/docs/assets/images/outputs/draw/resample/starry-night-resample-lanczos.webp differ diff --git a/docs/assets/images/outputs/draw/resample/starry-night-resample-nearest.webp b/docs/assets/images/outputs/draw/resample/starry-night-resample-nearest.webp new file mode 100644 index 0000000..70abe05 Binary files /dev/null and b/docs/assets/images/outputs/draw/resample/starry-night-resample-nearest.webp differ diff --git a/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t0.webp b/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t0.webp new file mode 100644 index 0000000..670bb95 Binary files /dev/null and b/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t0.webp differ diff --git a/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t108.webp b/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t108.webp new file mode 100644 index 0000000..03111df Binary files /dev/null and b/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t108.webp differ diff --git a/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t168.webp b/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t168.webp new file mode 100644 index 0000000..2bc265b Binary files /dev/null and b/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t168.webp differ diff --git a/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t210.webp b/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t210.webp new file mode 100644 index 0000000..a97c2ad Binary files /dev/null and b/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t210.webp differ diff --git a/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t70.webp b/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t70.webp new file mode 100644 index 0000000..85712dd Binary files /dev/null and b/docs/assets/images/outputs/draw/styles/braille/threshold/contributions-braille-t70.webp differ diff --git a/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-block.webp b/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-block.webp new file mode 100644 index 0000000..20985d1 Binary files /dev/null and b/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-block.webp differ diff --git a/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-default.webp b/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-default.webp new file mode 100644 index 0000000..a2aa7ac Binary files /dev/null and b/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-default.webp differ diff --git a/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-dot.webp b/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-dot.webp new file mode 100644 index 0000000..071a451 Binary files /dev/null and b/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-dot.webp differ diff --git a/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-hash.webp b/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-hash.webp new file mode 100644 index 0000000..a7cb872 Binary files /dev/null and b/docs/assets/images/outputs/draw/styles/gradient/charset/slack-gradient-charset-hash.webp differ diff --git a/docs/assets/images/outputs/draw/styles/gradient/negative/github-gradient-negative.webp b/docs/assets/images/outputs/draw/styles/gradient/negative/github-gradient-negative.webp new file mode 100644 index 0000000..b010ff5 Binary files /dev/null and b/docs/assets/images/outputs/draw/styles/gradient/negative/github-gradient-negative.webp differ diff --git a/docs/assets/images/outputs/draw/styles/gradient/negative/github-gradient-normal.webp b/docs/assets/images/outputs/draw/styles/gradient/negative/github-gradient-normal.webp new file mode 100644 index 0000000..6b70c22 Binary files /dev/null and b/docs/assets/images/outputs/draw/styles/gradient/negative/github-gradient-normal.webp differ diff --git a/docs/assets/images/outputs/format/colorize/instagram-color.webp b/docs/assets/images/outputs/format/colorize/instagram-color.webp new file mode 100644 index 0000000..040d7d5 Binary files /dev/null and b/docs/assets/images/outputs/format/colorize/instagram-color.webp differ diff --git a/docs/assets/images/outputs/format/colorize/instagram-gray.webp b/docs/assets/images/outputs/format/colorize/instagram-gray.webp new file mode 100644 index 0000000..794ff48 Binary files /dev/null and b/docs/assets/images/outputs/format/colorize/instagram-gray.webp differ diff --git a/docs/assets/images/subjects/contributions.webp b/docs/assets/images/subjects/contributions.webp new file mode 100644 index 0000000..3ffbc40 Binary files /dev/null and b/docs/assets/images/subjects/contributions.webp differ diff --git a/docs/assets/images/subjects/github.webp b/docs/assets/images/subjects/github.webp new file mode 100644 index 0000000..a3f96c7 Binary files /dev/null and b/docs/assets/images/subjects/github.webp differ diff --git a/docs/assets/images/subjects/instagram.webp b/docs/assets/images/subjects/instagram.webp new file mode 100644 index 0000000..ea67a43 Binary files /dev/null and b/docs/assets/images/subjects/instagram.webp differ diff --git a/docs/assets/images/subjects/slack.webp b/docs/assets/images/subjects/slack.webp new file mode 100644 index 0000000..3ad625d Binary files /dev/null and b/docs/assets/images/subjects/slack.webp differ diff --git a/docs/assets/images/subjects/starry-night.webp b/docs/assets/images/subjects/starry-night.webp new file mode 100644 index 0000000..5e79874 Binary files /dev/null and b/docs/assets/images/subjects/starry-night.webp differ diff --git a/docs/assets/images/subjects/zima.webp b/docs/assets/images/subjects/zima.webp new file mode 100644 index 0000000..1f1f762 Binary files /dev/null and b/docs/assets/images/subjects/zima.webp differ diff --git a/docs/commands/draw/braille.md b/docs/commands/draw/braille.md new file mode 100644 index 0000000..18b5c3d --- /dev/null +++ b/docs/commands/draw/braille.md @@ -0,0 +1,43 @@ +--- +title: "picharsso draw braille - CLI - Picharsso" +description: "Use the Braille style." +--- + +# `picharsso draw braille` + +*Use the [Braille style](/styles/braille/).* + +--8<-- "docs/snippets/chunks/draw/styles/braille/example.md" + +## Usage + +```bash +picharsso draw braille [options] +``` + +## Options + +### `-t`, `--threshold` `INTEGER` `RANGE` +: *Threshold pixel luminance (from grayscale). [default: 64]* + + ??? example + Consider the following image: + + --8<-- "docs/snippets/embed/subjects/contributions.html" + + ```bash + picharsso draw -c -H 32 docs/assets/images/subjects/contributions.webp braille -t + ``` + + Here's what it should look like: + + --8<-- "docs/snippets/chunks/draw/styles/braille/threshold.md" + + +### `-h`, `--help` +: *Show this message and exit.* + + ??? abstract "Message" + ``` + --8<-- "docs/snippets/cli/draw/braille/help.txt" + ``` diff --git a/docs/commands/draw/gradient.md b/docs/commands/draw/gradient.md new file mode 100644 index 0000000..9b8b69b --- /dev/null +++ b/docs/commands/draw/gradient.md @@ -0,0 +1,58 @@ +--- +title: "picharsso draw gradient - CLI - Picharsso" +description: "Use the gradient style." +--- + +# `picharsso draw gradient` + +*Use the [gradient style](/styles/gradient/).* + +--8<-- "docs/snippets/chunks/draw/styles/gradient/example.md" + +## Usage + +```bash +picharsso draw gradient [options] +``` + +## Options: + +### `-s`, `--charset` `TEXT` +: *Character set ordered by increasing 'brightness'. [default: :!?PG@]* + + ??? example + Consider the following image: + + --8<-- "docs/snippets/embed/subjects/slack.html" + + ```bash + picharsso draw -c -H 32 docs/assets/images/subjects/slack.webp gradient -s + ``` + + Here's what it should look like: + + --8<-- "docs/snippets/chunks/draw/styles/gradient/charset.md" + +### `-n`, `--negative` +: Whether to invert output text brightness. + + ??? example + Consider the following image: + + --8<-- "docs/snippets/embed/subjects/github.html" + + ```bash + picharsso draw -H 32 docs/assets/images/subjects/github.webp gradient [-n] + ``` + + Here's what it should look like: + + --8<-- "docs/snippets/chunks/draw/styles/gradient/negative.md" + +### `-h`, `--help` +: *Show this message and exit.* + + ??? abstract "Message" + ``` + --8<-- "docs/snippets/cli/draw/gradient/help.txt" + ``` diff --git a/docs/commands/draw/index.md b/docs/commands/draw/index.md new file mode 100644 index 0000000..7b631c6 --- /dev/null +++ b/docs/commands/draw/index.md @@ -0,0 +1,159 @@ +--- +title: "picharsso draw - CLI - Picharsso" +description: "Generate text art from an image." +--- + +# `picharsso draw` + +*Generate text art from an image.* + +## Usage + +``` +picharsso draw [options] [args] +``` + +## Arguments + +### `` +: *Path to the image file.* + +## Options + +### `-c`, `--colorize` +: *Apply image colors to output text.* + + ??? example + Consider the following image: + + --8<-- "docs/snippets/embed/subjects/instagram.html" + + ```bash + picharsso draw [-c] -H 32 docs/assets/images/subjects/instagram.webp gradient + ``` + + Here's what it should look like: + + --8<-- "docs/snippets/chunks/format/colorize.md" + +### `-m`, `--mode` [`ansi`|`html`] +: *Format mode for output text. [default: ansi]* + + --8<-- "docs/snippets/references/formats.md" + +### `-r`, `--resample` [`nearest`|`box`|`bilinear`|`hamming`|`bicubic`|`lanczos`] +: *Resampling filter. [default: nearest]* + + ??? example + Consider the following image: + + --8<-- "docs/snippets/embed/subjects/starry-night.html" + + ```bash + picharsso draw -c -term-h -r docs/assets/images/subjects/starry-night.webp gradient -s "█" + ``` + + Here's what it should look like: + + --8<-- "docs/snippets/chunks/draw/resample.md" + +### `-H`, `--height` `INTEGER` +: *Height of output text in characters.* + *If 0, derives from width. [default: 0]* + + !!! info "Lines" + `height` is the number of lines in the text output. + + ??? example + Consider the following image: + + --8<-- "docs/snippets/embed/subjects/zima.html" + + ```bash + picharsso draw -c -H 32 docs/assets/images/subjects/zima.webp gradient + ``` + + Here's what it should look like: + + --8<-- "docs/snippets/embed/outputs/draw/dimensions/zima-h32.html" + +### `-W`, `--width` `INTEGER` +: *Width of output text in characters.* + *If 0, derives from height. [default: 0]* + + !!! info "Characters per line" + `width` is the number of characters (including whitespace) per line in the text output. + + ??? example + Consider the following image: + + --8<-- "docs/snippets/embed/subjects/zima.html" + + ```bash + picharsso draw -c -W 32 docs/assets/images/subjects/zima.webp gradient + ``` + + Here's what it should look like: + + --8<-- "docs/snippets/embed/outputs/draw/dimensions/zima-w32.html" + +### `-term-h`, `--terminal-height` +: *Sets height to terminal height.* + + ??? example + Consider the following image: + + --8<-- "docs/snippets/embed/subjects/zima.html" + + ```bash + picharsso draw -c -term-h docs/assets/images/subjects/zima.webp gradient + ``` + + Here's what it should look like: + + --8<-- "docs/snippets/embed/outputs/draw/dimensions/zima-term-h.html" + + ??? bug + When used while [piping](https://en.wikipedia.org/wiki/Pipeline_(Unix)), + `height` is set to the default terminal height, + which is usually `24`. + +### `-term-w`, `--terminal-width` +: *Sets width to terminal width.* + + ??? example + Consider the following image: + + --8<-- "docs/snippets/embed/subjects/zima.html" + + ```bash + picharsso draw -c -term-w docs/assets/images/subjects/zima.webp gradient + ``` + + Here's what it should look like: + + --8<-- "docs/snippets/embed/outputs/draw/dimensions/zima-term-w.html" + + ??? bug + When used while [piping](https://en.wikipedia.org/wiki/Pipeline_(Unix)), + `width` is set to the default terminal width, + which is usually `80`. + +### `-h`, `--help` +: *Show this message and exit.* + + ??? abstract "Message" + ``` + --8<-- "docs/snippets/cli/draw/help.txt" + ``` + +## Subcommands + +--8<-- "docs/snippets/references/styles.md" + +### [`braille`](/commands/draw/braille/) +: Use the [Braille style](/styles/braille/). + +### [`gradient`](/commands/draw/gradient/) +: Use the [gradient style](/styles/gradient/). + diff --git a/docs/commands/index.md b/docs/commands/index.md new file mode 100644 index 0000000..819c95f --- /dev/null +++ b/docs/commands/index.md @@ -0,0 +1,32 @@ +--- +title: "picharsso - CLI - Picharsso" +description: "A utility for converting images to text art." +--- + +# `picharsso` + +*A utility for converting images to text art.* + +## Usage + +```bash +picharsso [options] [args] +``` + +## Options + +### `-h`, `--help` +: *Show this message and exit.* + + ??? abstract "Message" + ``` + --8<-- "docs/snippets/cli/help.txt" + ``` + +## Subcommands + +### [`draw`](/commands/draw/) +: *Generate text art from an image.* + +### [`info`](/commands/info/) +: *Displays package information.* diff --git a/docs/commands/info.md b/docs/commands/info.md new file mode 100644 index 0000000..75765ec --- /dev/null +++ b/docs/commands/info.md @@ -0,0 +1,25 @@ +--- +title: "picharsso info - CLI - Picharsso" +description: "Displays package information." +--- + +# `picharsso info` + +*Displays package information.* + +## Usage + +```bash +picharsso info [options] +``` + +## Options + +### `-h`, `--help` +: *Show this message and exit.* + + ??? abstract "Message" + ``` + --8<-- "docs/snippets/cli/info/help.txt" + ``` + \ No newline at end of file diff --git a/docs/snippets/chunks/draw/resample.md b/docs/snippets/chunks/draw/resample.md new file mode 100644 index 0000000..6bd0f59 --- /dev/null +++ b/docs/snippets/chunks/draw/resample.md @@ -0,0 +1,17 @@ +=== "resample = 'nearest'" + --8<-- "docs/snippets/embed/outputs/draw/resample/starry-night-resample-nearest.html" + +=== "'box'" + --8<-- "docs/snippets/embed/outputs/draw/resample/starry-night-resample-box.html" + +=== "'bilinear'" + --8<-- "docs/snippets/embed/outputs/draw/resample/starry-night-resample-bilinear.html" + +=== "'hamming'" + --8<-- "docs/snippets/embed/outputs/draw/resample/starry-night-resample-hamming.html" + +=== "'bicubic'" + --8<-- "docs/snippets/embed/outputs/draw/resample/starry-night-resample-bicubic.html" + +=== "'lanczos'" + --8<-- "docs/snippets/embed/outputs/draw/resample/starry-night-resample-lanczos.html" diff --git a/docs/snippets/chunks/draw/styles/braille/threshold.md b/docs/snippets/chunks/draw/styles/braille/threshold.md new file mode 100644 index 0000000..b1ed953 --- /dev/null +++ b/docs/snippets/chunks/draw/styles/braille/threshold.md @@ -0,0 +1,14 @@ +=== "threshold = 0" + --8<-- "docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t0.html" + +=== "70" + --8<-- "docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t70.html" + +=== "108" + --8<-- "docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t108.html" + +=== "168" + --8<-- "docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t168.html" + +=== "210" + --8<-- "docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t210.html" diff --git a/docs/snippets/chunks/draw/styles/gradient/charset.md b/docs/snippets/chunks/draw/styles/gradient/charset.md new file mode 100644 index 0000000..e06118a --- /dev/null +++ b/docs/snippets/chunks/draw/styles/gradient/charset.md @@ -0,0 +1,11 @@ +=== "charset = ' :!?PG@' (default)" + --8<-- "docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-default.html" + +=== "'.'" + --8<-- "docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-dot.html" + +=== "'#'" + --8<-- "docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-hash.html" + +=== "'█'" + --8<-- "docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-block.html" diff --git a/docs/snippets/chunks/draw/styles/gradient/negative.md b/docs/snippets/chunks/draw/styles/gradient/negative.md new file mode 100644 index 0000000..e0d20b3 --- /dev/null +++ b/docs/snippets/chunks/draw/styles/gradient/negative.md @@ -0,0 +1,5 @@ +=== "negative = False" + --8<-- "docs/snippets/embed/outputs/draw/styles/gradient/negative/github-gradient-normal.html" + +=== "True" + --8<-- "docs/snippets/embed/outputs/draw/styles/gradient/negative/github-gradient-negative.html" diff --git a/docs/snippets/chunks/format/colorize.md b/docs/snippets/chunks/format/colorize.md new file mode 100644 index 0000000..eebdea6 --- /dev/null +++ b/docs/snippets/chunks/format/colorize.md @@ -0,0 +1,5 @@ +=== "colorize = False" + --8<-- "docs/snippets/embed/outputs/format/colorize/instagram-gray.html" + +=== "True" + --8<-- "docs/snippets/embed/outputs/format/colorize/instagram-color.html" diff --git a/docs/snippets/cli/draw/braille/help.txt b/docs/snippets/cli/draw/braille/help.txt new file mode 100644 index 0000000..1979d9b --- /dev/null +++ b/docs/snippets/cli/draw/braille/help.txt @@ -0,0 +1,9 @@ +Usage: picharsso draw braille [options] + + Use the Braille style. + +Options: + -t, --threshold INTEGER RANGE Threshold pixel luminance (from grayscale). + [default: 64] + + -h, --help Show this message and exit. diff --git a/docs/snippets/cli/draw/gradient/help.txt b/docs/snippets/cli/draw/gradient/help.txt new file mode 100644 index 0000000..9587a90 --- /dev/null +++ b/docs/snippets/cli/draw/gradient/help.txt @@ -0,0 +1,10 @@ +Usage: picharsso draw gradient [options] + + Use the gradient style. + +Options: + -s, --charset TEXT Character set ordered by increasing 'brightness'. + [default: :!?PG@] + + -n, --negative Whether to invert output text brightness. + -h, --help Show this message and exit. diff --git a/docs/snippets/cli/draw/help.txt b/docs/snippets/cli/draw/help.txt new file mode 100644 index 0000000..e86efa5 --- /dev/null +++ b/docs/snippets/cli/draw/help.txt @@ -0,0 +1,28 @@ +Usage: picharsso draw [options] [args] + + Generate text art from an image. + + Path to the image file. + +Options: + -c, --colorize Apply image colors to output text. + -m, --mode [ansi|html] Format mode for output text. [default: + ansi] + + -r, --resample [nearest|box|bilinear|hamming|bicubic|lanczos] + Resampling filter. [default: nearest] + -H, --height INTEGER Height of output text in characters. + + If 0, derives from width. [default: 0] + + -W, --width INTEGER Width of output text in characters. + + If 0, derives from height. [default: 0] + + -term-h, --terminal-height Sets height to terminal height. + -term-w, --terminal-width Sets width to terminal width. + -h, --help Show this message and exit. + +Commands: + braille Use the Braille style. + gradient Use the gradient style. diff --git a/docs/snippets/cli/help.txt b/docs/snippets/cli/help.txt new file mode 100644 index 0000000..6dd3521 --- /dev/null +++ b/docs/snippets/cli/help.txt @@ -0,0 +1,10 @@ +Usage: picharsso [options] [args] + + A utility for converting images to text art. + +Options: + -h, --help Show this message and exit. + +Commands: + draw Generate text art from an image. + info Displays package information. diff --git a/docs/snippets/cli/info/help.txt b/docs/snippets/cli/info/help.txt new file mode 100644 index 0000000..8aac6a2 --- /dev/null +++ b/docs/snippets/cli/info/help.txt @@ -0,0 +1,6 @@ +Usage: picharsso info [options] + + Displays package information. + +Options: + -h, --help Show this message and exit. diff --git a/docs/snippets/embed/outputs/draw/dimensions/zima-h32.html b/docs/snippets/embed/outputs/draw/dimensions/zima-h32.html new file mode 100644 index 0000000..af296db --- /dev/null +++ b/docs/snippets/embed/outputs/draw/dimensions/zima-h32.html @@ -0,0 +1,6 @@ +
+ Zima Blue (with height = 32) +
diff --git a/docs/snippets/embed/outputs/draw/dimensions/zima-term-h.html b/docs/snippets/embed/outputs/draw/dimensions/zima-term-h.html new file mode 100644 index 0000000..433020f --- /dev/null +++ b/docs/snippets/embed/outputs/draw/dimensions/zima-term-h.html @@ -0,0 +1,6 @@ +
+ Zima Blue (with terminal height) +
diff --git a/docs/snippets/embed/outputs/draw/dimensions/zima-term-w.html b/docs/snippets/embed/outputs/draw/dimensions/zima-term-w.html new file mode 100644 index 0000000..765558d --- /dev/null +++ b/docs/snippets/embed/outputs/draw/dimensions/zima-term-w.html @@ -0,0 +1,6 @@ +
+ Zima Blue (with terminal width) +
diff --git a/docs/snippets/embed/outputs/draw/dimensions/zima-w32.html b/docs/snippets/embed/outputs/draw/dimensions/zima-w32.html new file mode 100644 index 0000000..d4ac7ef --- /dev/null +++ b/docs/snippets/embed/outputs/draw/dimensions/zima-w32.html @@ -0,0 +1,6 @@ +
+ Zima Blue (with width = 32) +
diff --git a/docs/snippets/embed/outputs/draw/resample/starry-night-resample-bicubic.html b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-bicubic.html new file mode 100644 index 0000000..a799a08 --- /dev/null +++ b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-bicubic.html @@ -0,0 +1,6 @@ +
+ Starry Night (bicubic resampling) +
diff --git a/docs/snippets/embed/outputs/draw/resample/starry-night-resample-bilinear.html b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-bilinear.html new file mode 100644 index 0000000..bd2375f --- /dev/null +++ b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-bilinear.html @@ -0,0 +1,6 @@ +
+ Starry Night (bilinear resampling) +
diff --git a/docs/snippets/embed/outputs/draw/resample/starry-night-resample-box.html b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-box.html new file mode 100644 index 0000000..80aabe4 --- /dev/null +++ b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-box.html @@ -0,0 +1,6 @@ +
+ Starry Night (box resampling) +
diff --git a/docs/snippets/embed/outputs/draw/resample/starry-night-resample-hamming.html b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-hamming.html new file mode 100644 index 0000000..8fdf889 --- /dev/null +++ b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-hamming.html @@ -0,0 +1,6 @@ +
+ Starry Night (hamming resampling) +
diff --git a/docs/snippets/embed/outputs/draw/resample/starry-night-resample-lanczos.html b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-lanczos.html new file mode 100644 index 0000000..cfac3fd --- /dev/null +++ b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-lanczos.html @@ -0,0 +1,6 @@ +
+ Starry Night (lanczos resampling) +
diff --git a/docs/snippets/embed/outputs/draw/resample/starry-night-resample-nearest.html b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-nearest.html new file mode 100644 index 0000000..cebcf9c --- /dev/null +++ b/docs/snippets/embed/outputs/draw/resample/starry-night-resample-nearest.html @@ -0,0 +1,6 @@ +
+ Starry Night (nearest resampling) +
diff --git a/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t0.html b/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t0.html new file mode 100644 index 0000000..e82090b --- /dev/null +++ b/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t0.html @@ -0,0 +1,6 @@ +
+ Contributions in text (Braille Threshold 0) +
diff --git a/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t108.html b/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t108.html new file mode 100644 index 0000000..7139fb9 --- /dev/null +++ b/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t108.html @@ -0,0 +1,6 @@ +
+ Contributions in text (Braille Threshold 108) +
diff --git a/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t168.html b/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t168.html new file mode 100644 index 0000000..f436ef6 --- /dev/null +++ b/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t168.html @@ -0,0 +1,6 @@ +
+ Contributions in text (Braille Threshold 168) +
diff --git a/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t210.html b/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t210.html new file mode 100644 index 0000000..6bf053a --- /dev/null +++ b/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t210.html @@ -0,0 +1,6 @@ +
+ Contributions in text (Braille Threshold 210) +
diff --git a/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t70.html b/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t70.html new file mode 100644 index 0000000..c9556e0 --- /dev/null +++ b/docs/snippets/embed/outputs/draw/styles/braille/threshold/contributions-braille-t70.html @@ -0,0 +1,6 @@ +
+ Contributions in text (Braille Threshold 70) +
diff --git a/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-block.html b/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-block.html new file mode 100644 index 0000000..bc290bb --- /dev/null +++ b/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-block.html @@ -0,0 +1,6 @@ +
+ Slack logo in text (block charset) +
diff --git a/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-default.html b/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-default.html new file mode 100644 index 0000000..c2d65e7 --- /dev/null +++ b/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-default.html @@ -0,0 +1,6 @@ +
+ Slack logo in text (default charset) +
diff --git a/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-dot.html b/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-dot.html new file mode 100644 index 0000000..c0c70f0 --- /dev/null +++ b/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-dot.html @@ -0,0 +1,6 @@ +
+ Slack logo in text (dot charset) +
diff --git a/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-hash.html b/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-hash.html new file mode 100644 index 0000000..7b6d698 --- /dev/null +++ b/docs/snippets/embed/outputs/draw/styles/gradient/charset/slack-gradient-charset-hash.html @@ -0,0 +1,6 @@ +
+ Slack logo in text (hash charset) +
diff --git a/docs/snippets/embed/outputs/draw/styles/gradient/negative/github-gradient-negative.html b/docs/snippets/embed/outputs/draw/styles/gradient/negative/github-gradient-negative.html new file mode 100644 index 0000000..488210b --- /dev/null +++ b/docs/snippets/embed/outputs/draw/styles/gradient/negative/github-gradient-negative.html @@ -0,0 +1,6 @@ +
+ GitHub logo in text (negative) +
diff --git a/docs/snippets/embed/outputs/draw/styles/gradient/negative/github-gradient-normal.html b/docs/snippets/embed/outputs/draw/styles/gradient/negative/github-gradient-normal.html new file mode 100644 index 0000000..de33132 --- /dev/null +++ b/docs/snippets/embed/outputs/draw/styles/gradient/negative/github-gradient-normal.html @@ -0,0 +1,6 @@ +
+ GitHub logo in text +
diff --git a/docs/snippets/embed/outputs/format/colorize/instagram-color.html b/docs/snippets/embed/outputs/format/colorize/instagram-color.html new file mode 100644 index 0000000..5c94879 --- /dev/null +++ b/docs/snippets/embed/outputs/format/colorize/instagram-color.html @@ -0,0 +1,6 @@ +
+ Instagram logo in text (with color) +
diff --git a/docs/snippets/embed/outputs/format/colorize/instagram-gray.html b/docs/snippets/embed/outputs/format/colorize/instagram-gray.html new file mode 100644 index 0000000..c6d3250 --- /dev/null +++ b/docs/snippets/embed/outputs/format/colorize/instagram-gray.html @@ -0,0 +1,6 @@ +
+ Instagram logo in text (without color) +
diff --git a/docs/snippets/embed/subjects/contributions.html b/docs/snippets/embed/subjects/contributions.html new file mode 100644 index 0000000..bc245a5 --- /dev/null +++ b/docs/snippets/embed/subjects/contributions.html @@ -0,0 +1,6 @@ +
+

+ Contributions +

+ Tiles ressembling GitHub contributions +
diff --git a/docs/snippets/embed/subjects/github.html b/docs/snippets/embed/subjects/github.html new file mode 100644 index 0000000..9c3af0c --- /dev/null +++ b/docs/snippets/embed/subjects/github.html @@ -0,0 +1,6 @@ +
+

+ GitHub logo +

+ GitHub +
diff --git a/docs/snippets/embed/subjects/instagram.html b/docs/snippets/embed/subjects/instagram.html new file mode 100644 index 0000000..61c6429 --- /dev/null +++ b/docs/snippets/embed/subjects/instagram.html @@ -0,0 +1,6 @@ +
+

+ Instagram logo +

+ Instagram +
diff --git a/docs/snippets/embed/subjects/slack.html b/docs/snippets/embed/subjects/slack.html new file mode 100644 index 0000000..383ba1a --- /dev/null +++ b/docs/snippets/embed/subjects/slack.html @@ -0,0 +1,6 @@ +
+

+ Slack logo +

+ Slack +
diff --git a/docs/snippets/embed/subjects/starry-night.html b/docs/snippets/embed/subjects/starry-night.html new file mode 100644 index 0000000..cd2815c --- /dev/null +++ b/docs/snippets/embed/subjects/starry-night.html @@ -0,0 +1,6 @@ +
+

+ Starry Night +

+ Starry Night [Vincent van Gogh, 1889] +
diff --git a/docs/snippets/embed/subjects/zima.html b/docs/snippets/embed/subjects/zima.html new file mode 100644 index 0000000..9849a23 --- /dev/null +++ b/docs/snippets/embed/subjects/zima.html @@ -0,0 +1,6 @@ +
+

+ Zima Blue +

+ Zima Blue [Zima] +
diff --git a/src/cli/__init__.py b/src/cli/__init__.py index b7fe245..75195f7 100644 --- a/src/cli/__init__.py +++ b/src/cli/__init__.py @@ -1,3 +1,9 @@ +"""This package defines the `picharsso` command. + +Refer to https://kelvindecosta.github.io/picharsso/commands/. +""" + + import click from .draw import draw diff --git a/src/cli/draw/__init__.py b/src/cli/draw/__init__.py index be64608..b238bf4 100644 --- a/src/cli/draw/__init__.py +++ b/src/cli/draw/__init__.py @@ -1,3 +1,8 @@ +"""This package defines the `picharsso draw` command. + +Refer to https://kelvindecosta.github.io/picharsso/commands/draw/. +""" + import click from PIL import Image diff --git a/src/cli/draw/braille.py b/src/cli/draw/braille.py index d33cb96..06a624a 100644 --- a/src/cli/draw/braille.py +++ b/src/cli/draw/braille.py @@ -1,3 +1,9 @@ +"""This module defines the `picharsso draw braille` command. + +Refer to https://kelvindecosta.github.io/picharsso/commands/draw/braille/. +""" + + import click from ...draw import new_drawer diff --git a/src/cli/draw/gradient.py b/src/cli/draw/gradient.py index 6700124..293550e 100644 --- a/src/cli/draw/gradient.py +++ b/src/cli/draw/gradient.py @@ -1,3 +1,8 @@ +"""This module defines the `picharsso draw gradient` command. + +Refer to https://kelvindecosta.github.io/picharsso/commands/draw/gradient/. +""" + import click from ...draw import new_drawer diff --git a/src/cli/info.py b/src/cli/info.py index ac24f69..3abf516 100644 --- a/src/cli/info.py +++ b/src/cli/info.py @@ -1,3 +1,8 @@ +"""This module defines the `picharsso info` command. + +Refer to https://kelvindecosta.github.io/picharsso/commands/info/. +""" + from pathlib import Path import click