roman-numerals-py

A library for manipulating well-formed Roman numerals.

Integers between 1 and 3,999 (inclusive) are supported. Numbers beyond this range will return an OutOfRangeError.

The classical system of roman numerals requires that the same character may not appear more than thrice consecutively, meaning that ‘MMMCMXCIX’ (3,999) is the largest well-formed Roman numeral. The smallest is ‘I’ (1), as there is no symbol for zero in Roman numerals.

Both upper- and lower-case formatting of roman numerals are supported, and likewise for parsing strings, although the entire string must be of the same case. Numerals that do not adhere to the classical form are rejected with an InvalidRomanNumeralError.

Example usage

Creating a roman numeral

from roman_numerals import RomanNumeral

num = RomanNumeral(16)
assert str(num) == 'XVI'

num = RomanNumeral.from_string("XVI")
assert int(num) == 16

Convert a roman numeral to a string

from roman_numerals import RomanNumeral

num = RomanNumeral(16)
assert str(num) == 'XVI'
assert num.to_uppercase() == 'XVI'
assert num.to_lowercase() == 'xvi'
assert repr(num) == 'RomanNumeral(16)'

Extract the decimal value of a roman numeral

from roman_numerals import RomanNumeral

num = RomanNumeral(42)
assert int(num) == 42

Invalid input

from roman_numerals import RomanNumeral, InvalidRomanNumeralError

num = RomanNumeral.from_string("Spam!")  # raises InvalidRomanNumeralError
num = RomanNumeral.from_string("CLL")  # raises InvalidRomanNumeralError
num = RomanNumeral(0)  # raises OutOfRangeError
num = RomanNumeral(4_000)  # raises OutOfRangeError

Licence

This project is licenced under the terms of either the Zero-Clause BSD licence or the CC0 1.0 Universal licence. See LICENCE.rst for the full text of both licences.

Download files

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

Source Distribution

roman_numerals_py-3.1.0.tar.gz (9.0 kB view details)

Uploaded Feb 22, 2025 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

roman_numerals_py-3.1.0-py3-none-any.whl (7.7 kB view details)

Uploaded Feb 22, 2025 Python 3

File details

Details for the file roman_numerals_py-3.1.0.tar.gz.

File metadata

Download URL: roman_numerals_py-3.1.0.tar.gz
Upload date: Feb 22, 2025
Size: 9.0 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for roman_numerals_py-3.1.0.tar.gz
Algorithm	Hash digest
SHA256	`be4bf804f083a4ce001b5eb7e3c0862479d10f94c936f6c4e5f250aa5ff5bd2d`
MD5	`818e8252ca189c657bf7f860824eceb9`
BLAKE2b-256	`307648fd56d17c5bdbdf65609abbc67288728a98ed4c02919428d4f52d23b24b`

See more details on using hashes here.

Provenance

The following attestation bundles were made for roman_numerals_py-3.1.0.tar.gz:

Publisher: create-release.yml on AA-Turner/roman-numerals

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: roman_numerals_py-3.1.0.tar.gz
- Subject digest: be4bf804f083a4ce001b5eb7e3c0862479d10f94c936f6c4e5f250aa5ff5bd2d
- Sigstore transparency entry: 173456213
- Sigstore integration time: Feb 22, 2025
Source repository:
- Permalink: AA-Turner/roman-numerals@ec81337f99d8b557a6fce10f674c054050551444
- Branch / Tag: refs/tags/v3.1.0
- Owner: https://github.com/AA-Turner
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: create-release.yml@ec81337f99d8b557a6fce10f674c054050551444
- Trigger Event: push