Metadata-Version: 2.1
Name: code2img
Version: 0.0.2
Summary: Generate an image from source code (local or repository)
Home-page: https://github.com/leugimkm/code2img
Author: leugimkm
Author-email: leugimkm@systrien.com
License: MIT
Project-URL: Documentation, https://leugimkm.github.io/code2img/
Project-URL: Tracker, https://github.com/leugimkm/code2img/issues
Project-URL: Source, https://github.com/leugimkm/code2img
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Code2img

Use code2img from terminal to generate images of your source code

![GitHub](https://img.shields.io/github/license/leugimkm/code2img)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](./code_of_conduct.md)
![GitHub languages](https://img.shields.io/github/languages/top/leugimkm/code2img)
![GitHub repo size](https://img.shields.io/github/repo-size/leugimkm/code2img)
![Github last-commit](https://img.shields.io/github/last-commit/leugimkm/code2img)
![maintenance](https://img.shields.io/maintenance/yes/2022)

                                 
               _     ___ _           
     ___ ___ _| |___|_  |_|_____ ___ 
    |  _| . | . | -_|  _| |     | . |
    |___|___|___|___|___|_|_|_|_|_  |
                                |___|


`code2img` is a simple tool to generate an image from a local file or
from a GitHub repository. It can also be used to send the source code
to carbon.now.sh and generate the image there.

# Installation

`code2img` is available on [PyPi](https://pypi.org/project/code2img/) (MIT license)
and installation can be performed by running [pip](https://docs.python.org/es/3/installing/index.html)

```
python -m pip install code2img
```
To upgrade the package:
```
python -m pip install code2img --upgrade
```
To delete the package:
```
python -m pip uninstall code2img
```

# Example

To generate an image from a local file:

    > python -m code2img main.py -s
    Done!
    Image created in current directory: main.png

To generate an image from a GitHub repository:

    > python -m code2img soluciones/fibonacci.py -g
    Done!
    Image created in current directory: fibonacci.png

You can also send the content of the source code to carbon.now.sh:

    > python -m code2img main.py -c
    Sent to Carbon.now.sh

    > python -m code2img soluciones/fibonacci.py -gc
    Sent to Carbon.now.sh

Help command:

    > code2img -h

or:

    > code2img --help


# Contribution

If you'd like to contribute, fork the repository, commit your changes to main branch 
and send a pull request.
Make sure you add yourself to authors.


