pixel-console-image

Name	pixel-console-image JSON
Version	1.0.3 JSON
	download
home_page	https://github.com/El1teWatermelonGames/pci
Summary	A simple image renderer & editor for the terminal using the .pci filetype
upload_time	2023-01-04 17:41:03
maintainer
docs_url	None
author	Elite Watermelon
requires_python
license	Apache 2.0
keywords	pci rem pci rem
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Pixel Console Image Renderer, Editor & Module

A simple renderer for images in the terminal using the .pci file format

## Installation & Usage

### Installing Via PyPI

Run this command to install PCI

`$ pip install pci`

Then to run PCI, run the following in your terminal

`$ pci`

### Installing Via GitHub

```
$ git clone https://github.com/El1teWatermelonGames/pci.git
$ cd pci
$ python setup.py install
```

Then to run PCI, run the following in your terminal

`$ pci`

## Usage in code

### Rendering an image file

To render an existing image file you have to use the renderImage() function

***image.pci***
```
FFF000FFF00FFF
F0F00F000000F0
FFF00F000000F0
F0000F000000F0
F00000FFF00FFF
```

***example.py***
```
from pci.rem import renderImage

renderImage("image.pci")
```

### Rendering image data

This time you reformat the image yourself as a list in python & put it through a seperate function, renderData()

***example.py***
```
from pci.rem import renderData

image = [
    "FFF000FFF00FFF",
    "F0F00F000000F0",
    "FFF00F000000F0",
    "F0000F000000F0",
    "F00000FFF00FFF"
]

renderData(image)
```


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/El1teWatermelonGames/pci",
    "name": "pixel-console-image",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "pci,rem,pci rem",
    "author": "Elite Watermelon",
    "author_email": "elitewatermelongames@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/5f/1e/59c929d86c463488fed585fb60457ba975a49eca91b12d978a2ceb119870/pixel_console_image-1.0.3.tar.gz",
    "platform": null,
    "description": "# Pixel Console Image Renderer, Editor & Module\n\nA simple renderer for images in the terminal using the .pci file format\n\n## Installation & Usage\n\n### Installing Via PyPI\n\nRun this command to install PCI\n\n`$ pip install pci`\n\nThen to run PCI, run the following in your terminal\n\n`$ pci`\n\n### Installing Via GitHub\n\n```\n$ git clone https://github.com/El1teWatermelonGames/pci.git\n$ cd pci\n$ python setup.py install\n```\n\nThen to run PCI, run the following in your terminal\n\n`$ pci`\n\n## Usage in code\n\n### Rendering an image file\n\nTo render an existing image file you have to use the renderImage() function\n\n***image.pci***\n```\nFFF000FFF00FFF\nF0F00F000000F0\nFFF00F000000F0\nF0000F000000F0\nF00000FFF00FFF\n```\n\n***example.py***\n```\nfrom pci.rem import renderImage\n\nrenderImage(\"image.pci\")\n```\n\n### Rendering image data\n\nThis time you reformat the image yourself as a list in python & put it through a seperate function, renderData()\n\n***example.py***\n```\nfrom pci.rem import renderData\n\nimage = [\n    \"FFF000FFF00FFF\",\n    \"F0F00F000000F0\",\n    \"FFF00F000000F0\",\n    \"F0000F000000F0\",\n    \"F00000FFF00FFF\"\n]\n\nrenderData(image)\n```\n\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "A simple image renderer & editor for the terminal using the .pci filetype",
    "version": "1.0.3",
    "split_keywords": [
        "pci",
        "rem",
        "pci rem"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5f1e59c929d86c463488fed585fb60457ba975a49eca91b12d978a2ceb119870",
                "md5": "b44b281bf431c1d1d7e6f20eaa3f296a",
                "sha256": "5b0418dd94e42a66378345bbd392b9acd9e487a7de707d8f3bc31d605a689370"
            },
            "downloads": -1,
            "filename": "pixel_console_image-1.0.3.tar.gz",
            "has_sig": true,
            "md5_digest": "b44b281bf431c1d1d7e6f20eaa3f296a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8753,
            "upload_time": "2023-01-04T17:41:03",
            "upload_time_iso_8601": "2023-01-04T17:41:03.237135Z",
            "url": "https://files.pythonhosted.org/packages/5f/1e/59c929d86c463488fed585fb60457ba975a49eca91b12d978a2ceb119870/pixel_console_image-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-04 17:41:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "El1teWatermelonGames",
    "github_project": "pci",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pixel-console-image"
}