roman-numerals-converter 0.3.1.dev1706448029

No project description provided

Roman Numeral Converter

This Python CLI (Command-Line Interface) project, developed for the "Moderne Softwareentwicklung" course, offers an efficient way to convert integers to Roman numerals and vice versa. Built with the Click library, it provides a user-friendly experience on the command line.

Features

• Integer to Roman Numeral Conversion: Convert integers within the range of 1 to 3999 into Roman numerals.
• Roman Numeral to Integer Conversion: Translate valid Roman numerals back into integers.

Getting Started

Prerequisites

• Poetry for dependency management.
• pip for package installation.

Installation

Using Poetry

1. Clone the Repository

   git clone https://github.com/your-repository/roman-numeral-converter.git
   cd roman-numeral-converter
   

2. Install Dependencies

   poetry install
   

Using pip

If you prefer to use pip:

pip install roman-numeral-converter

Usage

Once installed, the CLI can be used as follows:

1. Convert an Integer to a Roman Numeral

   Syntax:

   poetry run python -m roman.your_module_name to-roman [number]
   

   Replace [number] with the integer you wish to convert.

2. Convert a Roman Numeral to an Integer

   Syntax:

   poetry run python -m roman.your_module_name from-roman [roman_numeral]
   

   Replace [roman_numeral] with the Roman numeral you wish to translate.

Contributing

Contributions are welcome! Please read our Contributing Guidelines for more information.

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

• Thanks to the "Moderne Softwareentwicklung" course team for their guidance.
• Click, for making command-line interface creation efficient.