regtech-regex

Shared data validations using regular expressions for use at the CFPB. This repo aims to collect sensible regex data validations in one YAML file for use across multiple tech stacks in the Small Business Lending project and maybe beyond.

This YAML file is subject to sudden and breaking changes while the Small Business Lending project is in development, so use at your own risk.

Dependencies

Dependencies will be defined within the individual language package managers.

Python

A python project has been defined in pyproject.toml, as well as the source under src/python/regtech_regex. Currently the only dependency used is pyyaml, which reads the yaml file into a python dict, which is then converted into a data class for use by clients of the library.

See the src/python/README.md for information on dependencies, installation and usage.

Installation

Import the validations.yaml file using the URL or via a package manager.

Python

See the src/python/README.md for information on dependencies, installation and usage.

Usage

Here's an example of an entry in the validations.yaml file:

rssd_id:
  description: must be an integer
  error_text: Must be a number.
  examples:
    - '9999'
    - '1'
  link: https://regex101.com/r/l3SyQi/3
  regex: ^\d+$

Each entry should be snake case, with common acronyms and initialisms being acceptable.

Each entry should have the following properties:

• description: a short description of how this value should be validated
• error_text: a user-friendly message that could be displayed on a frontend form validation
• examples: an array of strings that are examples of values that would be validated as being correct
• link: a link to regex101.com for live documentation and so devs can easily test the regular expression
• references: an array of links to external documentation
• regex: the regular expression that validates the value

Python

See the src/python/README.md for information on dependencies, installation and usage.

Getting help

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

Getting involved

Think you might have a simple regular expression that relates to consumer finance that might be helpful? Create an issue! See CONTRIBUTING for more details.

---

Open source licensing info

1. TERMS
2. LICENSE
3. CFPB Source Code Policy

---

Credits and references

1. Screenshot uses icons from the CFPB Design System and composed with tldraw