Skip to main content

Small code files to Images and Vice-Versa

Project description

Here is the updated version of your README.md file with the corrected usage example reflecting the command-line tool name imgrar-cli and the updated argument formats.

# ImgRar v1.1.0

## Overview
ImgRar is a versatile command-line tool for:
- **Code to PNG Conversion:** Transforming codes (up to several kilobytes in size) into visually encoded PNG images.
- **PNG to Code Conversion:** Decoding PNG images back into their original codes.
- **MP4 Video Preparation:** Preparing PNG files for MP4 video creation (future functionality).

## Key Features
- **Seamless Conversion:** Effortlessly switch between code and PNG formats.
- **Customizable Frame Size:** Specify the frame size during code-to-PNG conversions for precise output.
- **Flexible Directories:** Define input and output directories for streamlined workflows.

## Requirements
- **Python Version:** Python 3.6 or higher.
- **Dependencies:**
  - Built-in libraries: `argparse`, `os`.

## Installation
1. **Clone the Repository:**
   ```bash
   git clone https://github.com/your-repo/ImgRar.git
  1. Navigate to the Directory:
    cd ImgRar
    
  2. Install Required Dependencies: If additional modules are needed, install them using pip.

Usage

Command-Line Arguments

Run the tool with these arguments:

Argument Short Form Required Description
--Output -output Yes Directory to save the output files.
--Input -input Yes Directory containing input files to process.
--Code2Png -code2png No Enable code-to-PNG conversion mode.
--Png2Code -png2code No Enable PNG-to-code conversion mode.
--fsize -fsize No Set the frame size for PNG conversion (default: 320x240).

Example Commands

  1. Code to PNG Conversion:

    imgrar-cli -input ".\test\in" -output ".\test\out\test1" --Code2Png --fsize 640x480
    

    Converts code files in .\test\in to PNG images, saving them to .\test\out\test1 with a frame size of 640x480.

  2. PNG to Code Conversion:

    imgrar-cli -input ".\test\in" -output ".\test\out\test1" --Png2Code
    

    Converts PNG images in .\test\in back into code files, saving them to .\test\out\test1.

Notes

  • Implementation Details: Ensure the BaseConversion class in BaseConversion.py includes both code2png and png2code methods.
  • Input Files: Use appropriate input files for smooth processing.

License

This project is licensed under the MIT License. Refer to the LICENSE file for more details.

Contributing

We welcome contributions! To contribute:

  1. Fork the repository.
  2. Create a feature branch.
  3. Submit a pull request.

Contact

For support or questions, email: atharvdesai2002@gmail.com.


### Key Updates:
1. **Updated Command:**
   - The example commands now use `imgrar-cli` as the command to run the tool, instead of `python main.py`.

2. **Argument Format:**
   - The usage of `--Code2Png` and `--Png2Code` is now in the correct format as per your request.

3. **Frame Size Format:**
   - The frame size argument has been updated to `640x480` (with no asterisk), as it is more commonly specified this way in command-line tools.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Imgrar-1.1.0.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

Imgrar-1.1.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file Imgrar-1.1.0.tar.gz.

File metadata

  • Download URL: Imgrar-1.1.0.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.10

File hashes

Hashes for Imgrar-1.1.0.tar.gz
Algorithm Hash digest
SHA256 b528df7ab7d3690b3be5198cf4f38a79cdb2ef87ef1c33fa80b5fb67a6e3e118
MD5 3c4aca14384853124402dc361b33f9fe
BLAKE2b-256 67ad9b1b8bd38ecfff544eaa2259e4c6a5bb9109287b53c389d4a1904b2b731c

See more details on using hashes here.

File details

Details for the file Imgrar-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: Imgrar-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.10

File hashes

Hashes for Imgrar-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9a5741b82cb9fd4408fa3eae096f764cd9cf7e830b9bbbe9194dc647445c5ab8
MD5 4388a73e40b0113a9ee5e47511cab2c5
BLAKE2b-256 7086bf9f396f4a7158d56d03c905300893550f54e5c50bab21dc5212e8d458db

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page