Metadata-Version: 2.1
Name: openocd
Version: 0.3.0
Summary: Python interface library for OpenOCD
Home-page: https://gitlab.zapb.de/openocd/python-openocd
Author: Marc Schink
Author-email: dev@zapb.de
License: GPLv3+
Project-URL: Source, https://gitlab.zapb.de/openocd/python-openocd
Keywords: OpenOCD microcontroller debug embedded
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Embedded Systems
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typing-extensions>=4.0.0

# openocd

Python interface library for [OpenOCD](https://openocd.org/).


## Dependencies

* Python >= 3.10
* typing_extensions >= 4.0.0


## Installation

Prerequisites:

* Python 3.10 or higher

  * https://www.python.org/

* setuptools

  * https://pypi.org/project/setuptools/

To install this package, run:

```bash
python setup.py install
```


## Example

```python
from openocd import OpenOcd

with OpenOcd() as oocd:
    oocd.halt()
    registers = oocd.read_registers(['pc', 'sp'])

    print('Program counter: 0x%x' % registers['pc'])
    print('Stack pointer: 0x%x' % registers['sp'])

    oocd.resume()
```

## Support

If you appreciate the project, feel free to donate on Liberapay:

[![Liberapay donation link](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/zapb/donate)

## License

This project is licensed under the [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.en.html) - see the [LICENSE](LICENSE) file for details.


