feat: is_valid_cpf

Makefile

@@ -15,4 +15,4 @@ check:
 	@poetry run black -l 80 --check . --exclude=.venv
 
 test:
-	@poetry run python3 -m unittest discover tests/
+	@poetry run python3 -m unittest discover tests/ -v

README.md

@@ -26,16 +26,13 @@ pip install brutils
 
 ## Usage
 
-### Importing:
-```
->>> from brutils import cpf, cnpj
-```
-
 ### How do I validate a CPF or CNPJ?
 ```
 # numbers only, formatted as strings
 
->>> cpf.validate('00011122233')
+>>> from brutils import cnpj
+>>> from brutils.cpf import is_valid_cpf
+>>> is_valid_cpf('00011122233')
 False
 >>> cnpj.validate('00111222000133')
 False

README_PT_BR.md

@@ -28,16 +28,13 @@ pip install brutils
 
 ## Utilização
 
-### Importando a Biblioteca:
-```
->>> from brutils import cpf, cnpj
-```
-
 ### Como faço para validar um CPF ou CNPJ?
 ```
 # somente numeros, em formato string
 
->>> cpf.validate('00011122233')
+>>> from brutils import cnpj
+>>> from brutils.cpf import is_valid_cpf
+>>> is_valid_cpf('00011122233')
 False
 >>> cnpj.validate('00111222000133')
 False

brutils/cpf.py

@@ -71,6 +71,17 @@ def validate(cpf):  # type: (str) -> bool
     return all(hashdigit(cpf, i + 10) == int(v) for i, v in enumerate(cpf[9:]))
 
 
+def is_valid_cpf(cpf):  # type: (str) -> bool
+    """
+    Returns whether or not the verifying checksum digits of the
+    given `cpf` match it's base number. Input should be a digit
+    string of proper length.
+    Using this method name to match with the js library  api.
+    Using the same method to ensure backwards compatibility.
+    """
+    return validate(cpf)
+
+
 def generate():  # type: () -> str
     """Generates a random valid CPF digit string."""
     base = str(randint(1, 999999998)).zfill(9)

tests/test_cpf.py

@@ -8,7 +8,15 @@
 path.insert(
     1, abspath(join(dirname(abspath(getsourcefile(lambda: 0))), pardir))
 )
-from brutils.cpf import sieve, display, hashdigit, checksum, validate, generate
+from brutils.cpf import (
+    sieve,
+    display,
+    hashdigit,
+    checksum,
+    validate,
+    generate,
+    is_valid_cpf,
+)
 from unittest import TestCase, main
 
 
@@ -42,6 +50,11 @@ def test_validate(self):
         assert validate("52599927765")
         assert not validate("00000000000")
 
+    def test_is_valid_cpf(self):
+        assert is_valid_cpf("52513127765")
+        assert is_valid_cpf("52599927765")
+        assert not is_valid_cpf("00000000000")
+
     def test_generate(self):
         for i in range(1000):
             assert validate(generate())