Metadata-Version: 2.1
Name: hexdutils
Version: 1.4
Summary: Python library to deal with hexadecimals
Home-page: https://github.com/davix3f/hexutils
Author: davix3f
Author-email: davide_fiorito@libero.it
License: Apache 2.0
Description: # hexdutils
        
        **hexdutils** is a little (little little little) Python library to deal with hexadecimals.
        Int to hex, hex to int, text-to-hex, operations between hex.
        
        The code is in **dev** branch.
        
        ## Usage
        
        Function names are very clear by themselves, but here's a guide.
        
        ### intohex (\<int\>number, [\<bool\>hex_prefix, \<bool\>uppercase])
          Returns a the hex value of a number as a string.
          * **Arguments**:
            * **Mandatory**:
              * `int` number: the integer to convert;
            * **Optional**:
              * `bool` hex_prefix: adds "0x" at the beginning of the output, like the native `hex` Python function. Set as *False* by default;
              * `bool` uppercase: every letter in the output is uppercased. Set as *False* by default;
        ### hextoint (\<str\>target)
          Returns the value of an hex as an integer.
          * **Arguments**:
            * **Mandatory**:
              * `str` target: the hex value to convert. Accepts also "0x" values;
        ### abctohex (\<str\>target, [\<str\>conversion, \<list\>encrypt])
          Returns text converted in hex. Encryption available.
          * **Arguments**
            * **Mandatory**:
              * `str` target: text to convert;
            * **Optional**:
              * `str` conversion: the letter values to be used. "alphabet" uses the position of each letter in the alphabet to assign an integer value (e.g a=1, b=2, etc.). "ord" uses the result of `ord(letter)` (e.g `ord("a") = 97`). Set as *"ord"* by default:
              * `list` encrypt: list with encryption values. First item (greater or equal than 5) represents the range limit for `randint`. Second item (at least 0, bigger is better) is the number of iterations to perform on the string. Set as *False* by default.
            
        
        
        ### Operations
        
        |   Function	|  Operator 	|
        |:-:	         |:-:	|
        |**hex_add**     |  +   |
        |**hex_subtract**|  -   |
        |**hex_multiply**|  *   |
        |**hex_divide**  |  //  |
        |**hex_floor**   |  %   |
         
         Usage: `operation(<str>value_one, <str>value_two, [<bool>hex_output, <bool>hex_output_prefix. <bool>hex_output_upper])` 
         
         The arguments for those functions are all the same:
          * **Mandatory**:
            - `str`  value\_one;
            - `str`  value\_two;
            - `bool` hex_output: if set as True, the operation result will be returned as an hex value. If set as False, an integer will be returned;
          
          * **Optional**:
            - `bool` hex\_output\_prefix: If set as True, adds "0x" at the beginning of the output. Set as *False* by default;
            - `bool` hex\_output\_upper: If set as True, every letter in the output is uppercased. Set as *False* by default;
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
