A Python package for generating various visual representations of text in SVG format. +
## Installation @@ -20,17 +22,18 @@ pip install -e . ## Features -Generates SVG visualizations of text using various encoding methods: -- Binary Stripe -- Morse Code Band -- Circuit Trace Silhouette -- Dot Grid Steganography -- Semaphore Flags -- A1Z26 Numeric Stripe -- Code128 Barcode -- Waveform Stripe -- Chevron Stripe -- Braille Stripe +Generates SVG visualizations of text using 10 distinct encoding methods: + +1. **Binary Stripe**: Binary bar code representation +2. **Morse Code Band**: Dots and dashes visualization +3. **Circuit Trace Silhouette**: Circuit board-like pattern (5x7 grid per character) +4. **Dot Grid Steganography**: Grid with highlighted letters +5. **Semaphore Flags**: Flag position visualization +6. **A1Z26 Numeric Stripe**: Numeric representation of letters (A=1, Z=26) +7. **Code128 Barcode**: Standard Code128 barcode format +8. **Waveform Stripe**: Waveform visualization based on character ASCII values +9. **Chevron Stripe**: Chevron pattern based on binary representation +10. **Braille Stripe**: Visual representation of Braille characters ## Usage @@ -38,130 +41,86 @@ Generates SVG visualizations of text using various encoding methods: encoderize --text "HELLO" --output-dir output ``` -Options: -- `--text`, `-t`: Text to visualize (required) -- `--output-dir`, `-o`: Output directory (default: 'output') -- `--dark`: Generate dark mode versions -- `--light`: Generate light mode versions +**Options:** -## Development +* `--text`, `-t`: Text to visualize (required) +* `--output-dir`, `-o`: Output directory (default: 'output') +* `--dark`: Generate dark mode versions (white on black) +* `--light`: Generate light mode versions (black on white) -Install development dependencies: -```bash -pip install -e ".[dev]" -``` - -Run tests: -```bash -pytest -``` +If neither `--dark` nor `--light` is specified, both versions will be generated. -## Available Visualizations +## Example Visualizations -1. **Binary Stripe** - Binary bar code representation -2. **Morse Code Band** - Dots and dashes visualization -3. **Circuit Trace Silhouette** - Circuit board-like pattern -4. **Dot Grid Steganography** - Grid with highlighted letters -5. **Semaphore Flags** - Flag position visualization -6. **A1Z26 Numeric Stripe** - Numeric representation of letters -7. **Code128 Barcode** - Standard barcode format -8. **Waveform Stripe** - Waveform visualization -9. **Chevron Stripe** - Chevron pattern visualization -10. **Braille Stripe** - Braille representation - -## Requirements - -- Python 3.8 or higher -- svgwrite -- treepoem +*WIP* ## Output Structure -For input text "example", the output structure will be: +For input text like `"HELLO"`, the output structure will be: ``` output/ -└── example/ +└── HELLO/ ├── light/ - │ ├── binary_stripe_example.svg - │ ├── morse_code_band_example.svg - │ └── ... + │ ├── binary_stripe_HELLO.svg + │ ├── morse_code_band_HELLO.svg + │ ├── circuit_trace_silhouette_HELLO.svg + │ ├── dot_grid_steganography_HELLO.svg + │ ├── semaphore_flags_HELLO.svg + │ ├── a1z26_stripe_HELLO.svg + │ ├── code128_barcode_HELLO.svg + │ ├── waveform_stripe_HELLO.svg + │ ├── chevron_stripe_HELLO.svg + │ └── braille_stripe_HELLO.svg └── dark/ - ├── binary_stripe_example.svg - ├── morse_code_band_example.svg - └── ... + ├── binary_stripe_HELLO.svg + ├── morse_code_band_HELLO.svg + └── ... (and so on for all 10 types) ``` ## Customization -Each visualization function accepts various parameters to customize the appearance: - -- Colors -- Sizes -- Spacing -- Dimensions - -See the function docstrings for detailed parameter information. - -## License - -MIT License - -## Features - -The tool generates 10 different visual encodings for any input text: - -1. **Binary Pulse Stripe**: Converts text to binary and creates a visual stripe pattern -2. **Morse Code Band**: Creates a visual representation of Morse code -3. **Circuit Trace Silhouette**: Generates a 5x7 circuit-like pattern -4. **Steganographic Dot-Grid Pattern**: Creates a grid with highlighted dots representing letters -5. **Semaphore Flags**: Visual representation of semaphore flag positions -6. **A1Z26 Numeric Stripe**: Converts letters to their position in the alphabet -7. **Code128 Barcode**: Generates a standard barcode -8. **Waveform Stripe**: Creates a waveform pattern based on character values -9. **Chevron Stripe**: Binary-based chevron pattern -10. **Braille Stripe**: Visual representation of Braille characters - -## Dependencies +Each visualization function in `encoderize/visualizers.py` accepts optional parameters to customize the appearance (e.g., colors, sizes, spacing, dimensions). -- svgwrite: For SVG file generation -- pillow: For image processing -- treepoem: For barcode generation +See the function docstrings within `encoderize/visualizers.py` for detailed parameter information. -## Output Structure +## Development -For input text "example", the output structure will be: +Install development dependencies: +```bash +pip install -e ".[dev]" +``` +Run tests: +```bash +pytest ``` -output_example/ -├── light/ -│ ├── binary_stripe_example.svg -│ ├── morse_code_band_example.svg -│ └── ... -└── dark/ - ├── binary_stripe_example.svg - ├── morse_code_band_example.svg - └── ... + +Run linters (e.g., flake8, black): +```bash +# Example using flake8 +flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics +# Example using black +black . --check ``` -## Customization +## Requirements -The script includes various parameters that can be modified to adjust the visual appearance of the encodings, such as: +* Python 3.8 or higher +* `svgwrite` +* `treepoem` (and its dependency Ghostscript for barcode generation) -- Colors -- Sizes -- Spacing -- Dimensions +## License -To modify these parameters, edit the corresponding function parameters in `encoding-names.py`. +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. -## Contact +## Contributing -For questions or feedback, please contact me at [haydenpmac@gmail.com](mailto:haydenpmac@gmail.com) +Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for details on how to report bugs, suggest features, and submit pull requests. -## Contributing +## Contact -Contributions are welcome! Please open an issue or submit a pull request. +For questions or feedback, please contact Hayden MacDonald at [haydenpmac@gmail.com](mailto:haydenpmac@gmail.com). ## Contributors