Skip to Main Content

page_parts

Getting Started

Once you have verified your installation of the client, you can start using it. The Binubuo client core functionality, such as getting random data from the generators, synthetic data from the datasets and offloading data directly to files.

Remember your key

For the client to work, you need your Binubuo key. If you have not created an account yet you can do it from the client. If you already have an account, login to the Binubuo website and go to the settings page and copy your key.

Generating your first data

The core of Binubuo is generating random data. Simply import the library, connect with your key and call generate. The generate takes 2 arguments. The category of data and the name of the generator.


>>> # Import the binubuo library
>>> from binubuo import binubuo
>>> # Instantiate class and register your key
>>> myBinu = binubuo('YOURKEYHERE')
>>> # Generate a city
>>> myBinu.generate('location', 'city')
Copenhagen
>>> # Generate a name
>>> myBinu.generate('person', 'first_name')
Lewis

Generating synthetic data from sample datasets

Creating more than just a single value of random data, means calling the dataset command. For a complete list of predefined datasets, you can go here. If you are calling your own custom dataset then the only argument you need to supply is the name of the dataset. If you are a calling one of the predefined datasets, you need to add category and type.


>>> # Import the binubuo library
>>> from binubuo import binubuo
>>> # Instantiate class and register your key
>>> myBinu = binubuo('YOURKEYHERE')
>>> # Create data from the predefined users dataset.
>>> myBinu.dataset('user_list', 'standard', 'computer')
[[1194, 'F3A03E5B-D16C-3E26-E053-1810000AC2BD', '2022-09-14T04:22:45Z', 'Oliver Powell', 'Oliver.Powell@cunoni.org', 
'428 Cenciffa Circle', 'Coop 430', '33738', 'Iowa', 'solo', 6334523404276345, '11/2025', 
'c6f57c8db632c18ca72c35154f4177ce91958b4e47af6'], [1202, 'F3A03E5B-D16D-3E26-E053-1810000AC2BD', '2022-08-23T22:59:07Z', 
'Andrea Garcia', 'Andrea_Garcia@geslo.net', '238 Suvsij Square', 'Flat 563', '84097', 'North Carolina', 'maestro', 
5018247093027103, '05/2025', '4243d828b421d713f12a3c4dcb1de1a2f0c37978fc445'], [1240, 'F3A03E5B-D16E-3E26-E053-1810000AC2BD', 
'2022-05-26T13:35:04Z', 'Sofia Hill', 'Sofia.Hill@nor.org', '345 Hasut View', 'Coop 306', '84602', 'Vermont', 'bankcard', 
5610141753283796, '02/2024', '344b8869f4eb6ca1be0c2832e98b448c138d7e777cddd'], [1257, 'F3A03E5B-D16F-3E26-E053-1810000AC2BD', 
'2022-12-16T05:31:11Z', 'Sydney Davis', 'Sydney.Davis@tukli.int', '305 Letoctef Point', 'Hammond Residences 422', '19601', 
'Wisconsin', 'dccarte', 30080062784825, '06/2025', '9924ebb071a547284e5d774281e2046a8e6135b38b427'], [1295, 
'F3A03E5B-D170-3E26-E053-1810000AC2BD', '2022-06-22T16:50:06Z', 'Samantha Bell', 'Samantha.Bell@zapza.com', 
'214 Ropcup Square', 'Lux Residences 178', '42101', 'New Jersey', 'solo', 6334792720702434, '04/2025', 
'cba31d66d65628605faf4640d7a44d575a2a41b3ae21b'], [1307, 'F3A03E5B-D171-3E26-E053-1810000AC2BD', '2022-09-23T10:31:39Z', 
'Charlotte Adams', 'Charlotte_Adams@sogam.org', '23 Fasac Place', 'Vista Residences 209', '27679', 'Alaska', 'solo', 
6334381596907544, '10/2024', '275476a83c5ed5527519ec22077b9d6e86ceb5a0c54b6'], [1338, 'F3A03E5B-D172-3E26-E053-1810000AC2BD', 
'2022-07-07T21:37:09Z', 'Anthony Taylor', 'Anthony.Taylor@gasewi.int', '315 Pi Court', 'Coop 403', '96720', 'Indiana', 
'dcenroute', 201458287015272, '02/2026', '52cf7351e35e8bed2d68a3ef1846ee8f3e319a6969329'], [1346, 'F3A03E5B-D173-3E26-E053-1810000AC2BD', 
'2022-11-01T22:54:25Z', 'Stella Long', 'Stella.Long@fude.net', '263 Jilirko Court', 'Flat 46', '04401', 'Washington', 'visa', 
4844805475465121, '05/2026', '83652b169b6b7a4257e327dec328ce3ed35326583c974'], [1370, 'F3A03E5B-D174-3E26-E053-1810000AC2BD', 
'2023-01-20T03:53:21Z', 'Luis Flores', 'Luis_Flores@rejwomap.gov', '326 Pigtov Heights', 'Flat 237', '92133', 'Oregon', 
'electron', 4026217670245034, '06/2025', '7336addb246b4b6abae15b5abb2ab944e1563ec682e68'], [1399, 'F3A03E5B-D175-3E26-E053-1810000AC2BD', 
'2023-01-03T17:11:11Z', 'Audrey Bennett', 'Audrey.Bennett@ke.org', '484 Dir Manor', 'Skyline Suites 177', '29483', 'Michigan', 
'switch', 4903877451607344, '06/2025', '67ca2c7ed1d45819303d89bf122b96dc2e3d083ad5225']]

See the full documentation for the core module for a full description of the methods and functions.

Anchor Points

On this page

  • Remember your key
  • Generating your first data
  • Generating synthetic data from sample datasets