Skip to content

Commit 7c7a5c1

Browse files
committed
updated README with functions in 1.3
1 parent db428f0 commit 7c7a5c1

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
Python-generate_mac
22
===================
33

4-
Python library for Generating Ethernet MAC addresses. Can use the wireshark manuf
5-
for specific vendors, and or a random, but assigned address. Will work with
6-
any file formated the same as said file.
4+
Python library for working with Ethernet MAC addresses. Functions for generating
5+
transforming and testing MAC addresses.
6+
7+
Uses Wireshark's manuf, or s similarly formated file as input for specific
8+
Vendor ID(VID) bytes, for creating more
79

810
Supported functions:
911

12+
Generate
13+
--------
1014
**total_random()** - Procedurely generated MAC address, using random function.
1115

1216
**vid_file_random(_file_)** - uses random line from wireshark's manuf file
@@ -18,11 +22,20 @@ specify desc, which searches description within the vendor field
1822
**vid_provided(_vid bytes_)** - specify the VID bytes when calling the function.
1923
Random device bytes will be generated.
2024

25+
Test
26+
-------
2127
**list_vendors(_file_)** - return a python list [] with valid vendors
2228

2329
**is_mac_address(_mac_)** - Takes a string, and checks if it is a valid Ethernet
2430
MAC address. returns True or False(bool type)
2531

32+
Transform
33+
---------
34+
**get_vid_bytes(_mac_)** - Returns the vendor bytes(first three) from a MAC address.
35+
36+
**another_same_vid(_mac)** - Generates another MAC with diffrent device bytes
37+
with same vendor bytes as input
38+
2639
Usage
2740
-----
2841

0 commit comments

Comments
 (0)