text-morse-code-converter 0.1.2

A simple Morse code converter

Morse Code Converter

The Morse Code Converter is a Python package that facilitates the conversion between plain text and Morse code. It offers functionalities to encode text into Morse code and decode Morse code back into readable text. Additionally, it supports file-based conversions, allowing users to process entire files containing text or Morse code.​

Team members

• Andy Liu
• Chenxin Yan
• Willow
• Leo Wu

Link to PyPI website

• Morse code converter

Features

• Text to Morse Code Conversion: Convert any given text into its Morse code representation.​
• Morse Code to Text Conversion: Decode Morse code sequences back into plain text.​
• File Conversion: Process files to convert their contents between text and Morse code.
• Morse Code to Audio: Can play sound for morse code through a combination of long and short beeps.

Development set up

1. Install Python (3.11+), pipenv, and Git.
2. Make sure pipenv is installed pip install pipenv
3. Activate the virtual environment with pipenv shell
4. Install package with pip install -e . (please include the dot after -e).

Example commands to run the package

• Example commands for text to morse: python -m text_morse_code_converter --text "HELLO WORLD"
• Example commands for morse to text: python -m text_morse_code_converter --morse ".... . .-.. .-.. --- / .-- --- .-. .-.. -.."
• Example commands for text input file to morse output file: python -m text_morse_code_converter --input_file input.txt --output_file output.txt --file_mode text_to_morse
• Example commands for morse input file to text output file: python -m text_morse_code_converter --input_file input.txt --output_file output.txt --file_mode morse_to_text
• Example commands for including a sound output: python -m text_morse_code_converter --text "HELLO WORLD" --sound

How to run unit tests

Some example unit tests are included within the tests directory. To run these tests...

1. Follow steps in development set up.
2. Install pytest into the virtual environment by the command pipenv install pytest.
3. Run pipenv run pytest in the main project directory.
4. Tests should never fail. Any failed tests indicate that the production code is behaving differently from the behavior expected.

Continuous integration

This project has a continuous integration workflow that builds and runs unit tests with every code update to Github.

How to contribute

We welcome contributions from the community. To set up the development environment:

1. Clone this repo.
2. Follow the steps in development set up.