https://github.com/cyberboysumanjay/carbon-api

Unofficial API for generating beautiful images of your source code using Carbon.
https://github.com/cyberboysumanjay/carbon-api

api beautiful beautiful-code carbon carbonnowsh code flask get heroku image post pyppeteer python python3 snippet

Last synced: 4 months ago
JSON representation

Unofficial API for generating beautiful images of your source code using Carbon.

• Host: GitHub
• URL: https://github.com/cyberboysumanjay/carbon-api
• Owner: cyberboysumanjay
• License: lgpl-3.0
• Created: 2020-05-28T18:49:01.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-09-26T10:12:59.000Z (almost 2 years ago)
• Last Synced: 2025-02-27T03:05:39.471Z (4 months ago)
• Topics: api, beautiful, beautiful-code, carbon, carbonnowsh, code, flask, get, heroku, image, post, pyppeteer, python, python3, snippet
• Language: Python
• Homepage: https://carbonnowsh.herokuapp.com/
• Size: 98.6 KB
• Stars: 191
• Watchers: 5
• Forks: 46
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Carbon API [Unofficial]

---



    

        

    

    


    Unofficial API

    




### Show some :heart: and :star: the repo

[![GitHub stars](https://img.shields.io/github/stars/cyberboysumanjay/Carbon-API.svg?style=social&label=Star)](https://github.com/cyberboysumanjay/JioSaavnAPI)

![GitHub followers](https://img.shields.io/github/followers/cyberboysumanjay.svg?style=social&label=Follow)

[![Telegram Channel](https://img.shields.io/badge/Telegram-Channel-orange)](https://t.me/sjprojects)

## Carbon API written in Python using Flask and Pyppeteer

[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)

> **Carbon**  makes it easy to create and share beautiful images of your source code

#### Usage

You can use the API by sending a GET or a POST request using these params

| parameter              | default                    | type    | description                                      |

| ---------------------- | -------------------------- | ------- | ------------------------------------------------ |

| `code` (required)      |                            | string  | Code snippet                                     |

| `backgroundColor`      | `"rgba(171, 184, 195, 1)"` | string  | Hex or rgba color                                |

| `dropShadow`           | `true`                     | boolean | Turn on/off shadow                               |

| `dropShadowBlurRadius` | `"68px"`                   | string  | shadow blur radius                               |

| `dropShadowOffsetY`    | `"20px"`                   | string  | shadow offset y                                  |

| `exportSize`           | `"2x"`                     | string  | resolution of exported image, e.g. `1x`, `3x`    |

| `fontSize`             | `"14px"`                   | string  | font size                                        |

| `fontFamily`           | `"Hack"`                   | string  | font family, e.g. `JetBrains Mono`, `Fira Code`. |

| `firstLineNumber`      | `1`                        | number  | first line number                                |

| `language`             | `"auto"`                   | string  | programing language for properly highlighting    |

| `lineNumbers`          | `false`                    | boolean | turn on/off line number                          |

| `paddingHorizontal`    | `"56px"`                   | string  | horizontal padding                               |

| `paddingVertical`      | `"56px"`                   | string  | vertical padding                                 |

| `theme`                | `"seti"`                   | string  | code theme                                       |

| `watermark`            | `false`                    | boolean | turn on/off watermark                            |

| `widthAdjustment`      | `true`                     | boolean | turn on/off width adjustment                     |

| `windowControls`       | `true`                     | boolean | turn on/off window controls                      |

| `windowTheme`          | `"none"`                   | string  | window theme                                     |

### GET `/`

Params are encoded in url

```bash

https://carbonnowsh.herokuapp.com/?code=Made+with+Love+in+India+by+Sumanjay&theme=darcula&backgroundColor=rgba(144, 19, 254, 100)

```

### POST `/`

**Body** is JSON with these params:

```json

{

    "backgroundColor": "rgba(144, 19, 254, 100)",

    "code": "Made with Love in India by Sumanjay",

    "theme": "dracula"

}

```

### RESPONSE

**Response** is an image of a code or text snippet.



    

        

    



#### Deploy Option

* **[Heroku](https://www.heroku.com/) Method** 

  [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/cyberboysumanjay/Carbon-API/tree/master)

* **Other Method** 

  ```bash

  # Clone the repo

  git clone https://github.com/cyberboysumanjay/Carbon-API

  cd Carbon-API

  # Create virtualenv

  virtualenv -p /usr/bin/python3 venv

  ../venv/bin/activate

  # Install requirements

  pip3 install -r requirements.txt

  # Finally run the app

  python3 app.py

  ```

### Made with ❤️️ in India

### Copyright & License 

* Copyright (C) 2020 by [Sumanjay](https://github.com/cyberboysumanjay)

* Licensed under the terms of the [GNU GPL Version 3](https://github.com/cyberboysumanjay/Carbon-API/blob/master/LICENSE)