Ravenports generated: 08 Jan 2023 04:18
[ravenports.git] / bucket_51 / python-ouilookup
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-ouilookup
4 VERSION=                0.2.4
5 KEYWORDS=               python
6 VARIANTS=               py310 py311
7 SDESC[py310]=           MAC lookup from OUI source at ieee.org (3.10)
8 SDESC[py311]=           MAC lookup from OUI source at ieee.org (3.11)
9 HOMEPAGE=               https://github.com/verbnetworks/ouilookup
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/37/cf/db361db7914a30d1d8189d06eb0c0c35cc9ba1ab051752cfc02b522515e8
14 DISTFILE[1]=            ouilookup-0.2.4-py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[py310]=           single
17 SPKGS[py311]=           single
18
19 OPTIONS_AVAILABLE=      PY310 PY311
20 OPTIONS_STANDARD=       none
21 VOPTS[py310]=           PY310=ON PY311=OFF
22 VOPTS[py311]=           PY310=OFF PY311=ON
23
24 DISTNAME=               ouilookup-0.2.4.dist-info
25
26 GENERATED=              yes
27
28 [PY310].USES_ON=                        python:py310,wheel
29
30 [PY311].USES_ON=                        python:py311,wheel
31
32 [FILE:3084:descriptions/desc.single]
33 # ouilookup
34
35 [PyPi]
36 [Python Versions]
37 [build tests]
38 [License]
39
40 A CLI tool and Python3 module for looking up hardware MAC addresses from
41 the published OUI source list at ieee.org.
42
43 ## Project
44 * https://github.com/verbnetworks/ouilookup/
45
46 ## Install
47 #### via PyPi
48 `bash
49 pip3 install ouilookup
50 `
51
52 #### Arch Linux (via AUR, and your favorite AUR-helper)
53 ```bash
54 yay -S ouilookup-py3
55 ```
56
57 #### via Source
58 ```bash
59 git clone https://github.com/verbnetworks/ouilookup
60 cd ouilookup
61 python3 -m venv venv
62 source venv/bin/activate
63 pip3 install -r requirements.txt
64 python3 setup.py clean
65 python3 setup.py test
66 python3 setup.py install
67 ```
68
69 ## Versions
70 Legacy versions based on year-date (eg v2018.2) have been hard-deprecated
71 in favour of a backward incompatible 
72 standard versioning scheme (eg v0.2.0).
73
74 ## CLI usage
75 ```text
76 usage: ouilookup [-h] [-q <hwaddr> | -u | -un | -s] [-d]
77
78 ouilookup v0.0.2
79
80 optional arguments:
81   -h, --help            show this help message and exit
82   -q <hwaddr>, --query <hwaddr>
83                         Query to locate matching MAC hardware address(es)
84 from
85                         the oui database. Addresses may be expressed in
86                         formats with or without ":" or "-" separators. Use
87 a
88                         space between addresses for more than one lookup in
89 a
90                         single query line.
91   -u, --update          Download the latest oui.txt from "standards-
92                         oui.ieee.org" and parse it to generate a local
93                         oui.json for use by OuiLookup. The following paths
94 (in
95                         order) are examined for write-access to save the
96                         oui.json data-file: /var/lib/ouilookup
97   -un, --update-no-download
98                         Parse the oui.txt file in the data-path and update
99 the
100                         local oui.json data-file without downloading the
101                         latest oui.txt update from
102 "standards-oui.ieee.org".
103   -s, --status          Return status information about the oui.json
104 data-file
105                         available to OuiLookup.
106
107   -d, --debug           Provide debug logging output to stderr.
108
109 A CLI tool for interfacing with the OuiLookup module that provides CLI
110 access
111 the query(), update() and status() functions. Outputs at the CLI are JSON
112 formatted thus allowing for easy chaining to other toolchains. The update()
113 function updates directly from "standards-oui.ieee.org" and the ouilookup
114 package provides an internal fallback oui.txt updated at time of packaging.
115 ```
116
117 ## Python3 Module usage
118
119 ```console
120 >>> from OuiLookup import OuiLookup
121
122 >>> OuiLookup().query('00:00:aa:00:00:00')
123 [{'0000AA000000': 'XEROX CORPORATION'}]
124
125 >>> OuiLookup().query('00:00:01:00:00:00 00-00-10-00-00-00 000011000000')
126 [{'000001000000': 'XEROX CORPORATION'}, {'000010000000': 'SYTEK INC.'},
127 {'000011000000': 'NORMEREL SYSTEMES'}]
128
129 >>> OuiLookup().update()
130 {'timestamp': '20200218Z234257', 'source_uri':
131 'http://standards-oui.ieee.org/oui/oui.txt', 'source_bytes': 4359180,
132 'source_md5': 'd901b821bbe2506e5837a1a522b48be6', 'source_sha1':
133
134
135 [FILE:111:distinfo]
136 bf03cc919f52381644a8f403af233f33425f6a01b4a1d031d5e53bbdb9325159      1644965 ouilookup-0.2.4-py3-none-any.whl
137