Metadata-Version: 2.1
Name: ciuy
Version: 0.3.3
Summary: Package for validating Uruguayan ids (work in progress).
Home-page: https://github.com/ismaelpadilla/ci_uy_py
Author: Ismael Padilla
Author-email: padillaismael92@gmail.com
License: MIT
Description: # ciuy
        
        ![PyPI](https://img.shields.io/pypi/v/ciuy)
        ![PyPI - Status](https://img.shields.io/pypi/status/ciuy)
        ![PyPI - License](https://img.shields.io/pypi/l/ciuy)
        
        Package for validating Uruguayan ids. 
        
        The methods in this package, work with strings and ignore any non-digit characters. Numbers are valid too. So for example, the following expressions represent the same document number:
        
        ```
        '1.234.567-2'
        '12345672'
        12345672
        ```
        
        This package includes the following functions:
        
        `validate_ci(ci: str) -> bool`: Returns true if `ci` is a valid document number, returns false otherwise. `ci` is a string which represents a document number, including the validation digit. `ci` can be a number as well.
        
        `validation_digit(ci: str) -> str`: Returns the validation digit for `ci`.
        
        `random() -> str`: Returns a random document number (including validation digit) in the (100.000, 9.999.999) range.
        
        # Installation
        
        ```
        $ pip install ciuy
        ```
        
        # Usage
        
        ```
        >>> import ciuy
        >>> ciuy.validate_ci("1.234.567-2")
        True
        >>> ciuy.validation_digit("1.234.567")
        '2'
        >>> ciuy.random()
        '82405816'
        ```
        
        # Testing
        
        This package includes some doctests, as well as unit tests that can be run with `nose2`.
        
        After cloning the repository, you can run the doctests with:
        
        ```
        $ python3 -m doctest ./ciuy/__init__.py -v
         (several lines ommited)
        11 passed and 0 failed.
        Test passed.
        ```
        
        Use `nose2` to run the unit tests:
        ```
        $ python3 -m nose2
        .........................................................................
        ----------------------------------------------------------------------
        Ran 73 tests in 0.008s
        
        OK
        ```
        
        # Todo
        
        - Better documentation (use *Read The Docs*?).
        - Maybe add command line scripts?
        - Readme in Spanish.
        
        ---
        
        Based on the ci_uy Ruby gem by Fernando Briano ([link](https://github.com/picandocodigo/ci_uy)).
Keywords: Uruguay,dni,id,eid,validation
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
