Carbon

Create beautiful carbon code images using python or terminal.

This is an unofficial asynchronous python wrapper for carbon.now.sh which can be also be used inside cli.

Installation

PyPI (recommended)

pip install carbon-api

Directly from Source

git clone https://github.com/StarkBotsIndustries/Carbon

cd Carbon

python setup.py install

Example

Usage

Using as an Asynchronous Library

import asyncio
from carbon import Carbon

client = Carbon()


async def main():
    img = await client.create("Your code here")
    print(img)


asyncio.run(main())

Options

You can pass globally usable options' values to Carbon class

from carbon import Carbon

client = Carbon(
    downloads_dir=os.getcwd(),  # Defaults to current directory
    colour="rgba(171, 184, 195, 1)",  # Hex or rgba color
    shadow=True,  # Turn on/off shadow
    shadow_blur_radius="68px",
    shadow_offset_y="20px",
    export_size="2x",  # resolution of exported image, e.g. 1x, 3x
    font_size="14px",
    font_family= "Hack",  # font family, e.g. JetBrains Mono, Fira Code.
    first_line_number=1,
    language="auto",  # programing language for properly highlighting
    line_numbers=False,  # turn on/off, line number
    horizontal_padding="56px",
    vertical_padding="56px",
    theme="seti",  # code theme
    watermark=False,  # turn on/off watermark
    width_adjustment=True,  # turn on/off width adjustment
    window_controls= True,  # turn on/off window controls
    window_theme=None
)

Same options are also available in Carbon.create method, which override the global options.

You can also specify the file name to the create method. Path to the image will be returned by the function.

path = await client.create(file="my-code.png")  # Path will be downloads_dir/file 
print(path)

Using CLI

$ carbon-app

Create beautiful carbon code images using python or terminal

Options:
  -v, --version         check the current version installed
  -f FILE, --file FILE  pass file path to read code from
  -c CODE, --code CODE  pass some code to make carbon

Enjoy the program :)

You can pass the file path using the file argument.

carbon-app --file path_to_file

or simply

carbon-app -f path_to_file

For example:

carbon-app --file main.py

Here main.py should be in the same directory.

You can also directly pass code (not recommended)

carbon-app --code your_code_here

or simply

carbon-app -c your_code_here

CLI is in beta version and other options aren't available currently. If you're interested in that functionality, let me know.

Credits

• cyberboysumanjay for Carbon-API.

Community and Support

Telegram Channel - StarkBots

Telegram Chat - StarkBotsChat

Copyright and License

• Copyright (C) 2022 Stark Bots <https://github.com/StarkBotsIndustries>

• Licensed under the terms of GNU Lesser General Public License v3 or later (LGPLv3+)