Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/adamnieto/codeography

:mag: :camera: Generate source code from an image of a code snippet/pseudocode using steganography
https://github.com/adamnieto/codeography

carbon-now carbon-now-cli rust steganography

Last synced: about 2 months ago
JSON representation

:mag: :camera: Generate source code from an image of a code snippet/pseudocode using steganography

Host: GitHub
URL: https://github.com/adamnieto/codeography
Owner: adamnieto
Created: 2019-05-03T23:34:54.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-01-21T21:20:03.000Z (12 months ago)
Last Synced: 2024-04-16T04:54:14.518Z (9 months ago)
Topics: carbon-now, carbon-now-cli, rust, steganography
Language: Rust
Homepage:
Size: 20.4 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# :camera: codeography
---
A CLI that creates code snippet images using `carbon-now-cli` ([here](https://github.com/mixn/carbon-now-cli)), however, it can also encapsulate and generate the source code these code snippets represent pictorially via steganography.

To understand a little bit better here is a diagram to explain:

![alt text](https://raw.githubusercontent.com/adamnieto/codeography/main/codeography_diagram.png)

## What is Steganography?

Steganography is the process of representing information within another message or physical/virtual object in such a way that is not evident in plain sight or after human inspection.

In other words, steganography is a way for us to hide messages within everyday files or objects.

## Inspiration and Use Case

* The inspiration for this project comes out of the need for providing customizable syntax highlighting to code snippets through an image without losing the ability to copy and paste the source code the code-snippet image represents pictorially. Intrinsically, this tool does the copying and pasting for you by simply generating the file from the code-snippet image you already have.

* For instance, this tool can be used to encode a source file of a program but display pictorially the pseudocode of that program.

* This CLI is useful for presentations that may contain code snippets, allowing the presenter to avoid styling the code manually for a slide but also not burden viewers in having to download a separate file, or copy/paste (formatting may screw up) the code snippet.

---

## Installation:

### Installing using Dev Container (recommended)

**Pre-requisites:** Please make sure that you have Docker installed on your machine and you are using Visual Studio Code.

1. Download this repo:

```bash
git clone https://github.com/adamnieto/codeography.git
```
2. Wait for the dev container to finish running including the `postCreateCommand` once that has finished it should have installed the `codeography` command and you can start using it.

### Installing Manually

1. Make sure that you have already installed the `carbon-now-cli`. Follow the installation rules [here](https://github.com/mixn/carbon-now-cli).

2. [Install Rust](https://www.rust-lang.org/tools/install/)

3. Download this repo:

```bash
git clone https://github.com/adamnieto/codeography.git

```

4. Once inside of the `codeography` directory run the following command:

```
cargo install --path .
```

---
## Usage:

### Creating a code snippet image

To create a code snippet image all you need to execute is the following command:

```
codeography imagify
```

Example:

In this example, codeography will delegate to the `carbon-now-cli` in interactive mode.

```
codeography imagify code_snippet.rs
```

[![asciicast](https://asciinema.org/a/244240.svg)](https://asciinema.org/a/244240)

### Encoding a code-snippet image to steganographic code-snippet image

```
codeography encode
```

Example:

In this example the CLI will create `codeography_code_snippet.png`.

```
codeography encode code_snippet.rs code_snippet.png codeography_code_snippet
```

[![asciicast](https://asciinema.org/a/244241.svg)](https://asciinema.org/a/244241)

### Decoding a steganographic code-snippet image to its original source code file

```
codeography decode
```

Example:

In this example the program will create `code_snippet.rs`.
```
codeography decode codeography_code_snippet.png code_snippet
```

[![asciicast](https://asciinema.org/a/244243.svg)](https://asciinema.org/a/244243)

---
## Notes

This project is still in its early stages. If you find any bugs please report them in the issues tab.