Metadata-Version: 2.4
Name: cb_bsdl_db
Version: 0.2.0
Summary: Chriesibaum's BSDL file parser
Project-URL: Homepage, https://github.com/chriesibaum/cb_bsdl_db
Project-URL: Documentation, https://chriesibaum.github.io/cb_bsdl_db/
Project-URL: Repository, https://github.com/chriesibaum/cb_bsdl_db
Author-email: Thomas <Thomas@chriesibaum.dev>
License: Apache-2.0
License-File: LICENSE
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12
Requires-Dist: cb-bsdl-parser
Provides-Extra: dev
Requires-Dist: autopep8; extra == 'dev'
Requires-Dist: bandit; extra == 'dev'
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: genbadge[all]; extra == 'dev'
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: pycodestyle; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Description-Content-Type: text/markdown

<h1 align="center">
Chriesibaum's BSDL file database

[![pypi](https://img.shields.io/pypi/v/cb_bsdl_db.svg)](https://pypi.org/project/cb_bsdl_db/)
[![python](https://img.shields.io/pypi/pyversions/cb_bsdl_db.svg)](https://pypi.org/project/cb_bsdl_db/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/cb_bsdl_db)](https://pypi.org/project/cb_bsdl_db/)
[![GitHub stars](https://img.shields.io/github/stars/chriesibaum/cb_bsdl_db.svg)](https://github.com/smarie/python-genbadge/stargazers)
<br>
[![Tests Status](https://raw.githubusercontent.com/chriesibaum/cb_bsdl_db/refs/heads/main/doc/tests-badge.svg)]()
[![Coverage Status](https://raw.githubusercontent.com/chriesibaum/cb_bsdl_db/refs/heads/main/doc/coverage-badge.svg)]()

</h1>

# cb_bsdl_db

cb_bsdl_db is a Python package that provides a curated BSDL (Boundary-Scan
Description Language) file database together with tools to build and query an
IDCODE index.

It is intended to make JTAG/Boundary-Scan workflows easier by giving you a
single place to look up available device BSDL files and map JTAG IDCODE values
to matching device definitions.

The project includes:
- a versioned BSDL file collection under bsdl_file_db/
- a generated JSON index for fast lookup in cb_bsdl_db/bsdl_db.json
- Python APIs in cb_bsdl_db/bsdl_db.py for integration into scripts and tools
- helper utilities in cb_bsdl_db_tools/ to regenerate the database from source
  BSDL files

## Installation

```bash
uv install cb-bsdl-db
```

## CLI

```bash
cb_bsdl_id_code_db --help
```
