Welcome to RandCSV’s documentation!

cli.py

randcsv.cli.cli(*args)[source]

CLI entry point.

randcsv.cli.parse_args(*args)[source]

Argument parser.

data_type.py

class randcsv.data_type.DataType[source]

An enumeration of the allowed data types.

value_generators.py

randcsv.value_generators.generate_float(num_of_bytes)[source]

Generates a cryptographically secure, random floating point.

Parameters:num_of_bytes (int) – number of decimal places
Returns:random float
Return type:float
randcsv.value_generators.generate_integer(num_of_bytes)[source]

Generates a cryptographically secure, random integer.

Parameters:num_of_bytes (int) – number of bytes
Returns:random integer
Return type:number
randcsv.value_generators.generate_token(num_of_bytes)[source]

Generates a cryptographically secure, random (URL safe) token.

Parameters:num_of_bytes (int) – number of bytes
Returns:random token
Return type:str
randcsv.value_generators.generate_value(all_value_types_sorted, data_types, byte_size)[source]

Generic value generator.

Parameters:
  • all_value_types_sorted (List[Tuple]) – list of tuples containing value types sorted by frequency
  • data_types (List[String]) – list of the desired sata types
  • byte_size (int) – number of bytes
Raises:

ValueError – Value must be either NaN, “empty”, or a valid data type (regular value).
Returns:

random value
Return type:

Union[String, Number, Float]
randcsv.value_generators.generator_factory(data_type)[source]

Factory function, returns the result of correct value generator.

Parameters:data_type (str) – data type of value
Raises:ValueError – Data type must be one of: str, int, float.
Returns:generator function
Return type:function

random_csv.py

class randcsv.random_csv.RandCSV(rows, cols, byte_size=8, data_types=None, nan_freq=0.0, empty_freq=0.0, index_col=False, title_row=False)[source]

All of the arguments (meta data) required to initialize randcsv.

to_file(file_name)[source]

Save the data to local file system.

Parameters:file_name – name of output file
Returns:None