devlib

mirror of https://github.com/ARM-software/devlib.git synced 2024-10-05 18:30:50 +01:00

Go to file

Metin Kaya b5715b6560 utils/misc: Move load_struct_from_yaml() from WA to devlib This is copied from WA (workload-automation/wa/utils/misc.py). Hence, published another PR [1] removes the implementation from WA. OTOH, this patch uses ``ruamel`` instead of ``yaml`` because of the latter's design issues. And also this patch fixes pylint issues in ``load_struct_from_yaml()``. [1] https://github.com/ARM-software/workload-automation/pull/1248 Signed-off-by: Metin Kaya <metin.kaya@arm.com>		2024-02-23 12:48:44 -08:00
devlib	utils/misc: Move load_struct_from_yaml() from WA to devlib	2024-02-23 12:48:44 -08:00
doc	target: Customize as_root parameter of *write_value()	2024-01-23 06:51:59 -08:00
src	instrument/daq: Use clock boottime for the time column of the energy measurements	2020-11-09 17:27:21 +00:00
tests	test_target: Add copyright statement	2024-01-23 06:51:59 -08:00
.gitignore	Add build/ and dist/ to .gitingore	2017-04-26 17:19:55 +01:00
.readthedocs.yml	docs: Add readthedocs config and requirements.txt	2021-10-28 11:03:08 +01:00
README.rst	README: Update to include installation notes for `paramiko`	2020-04-20 12:03:42 +01:00
setup.py	utils/misc: Move load_struct_from_yaml() from WA to devlib	2024-02-23 12:48:44 -08:00

README.rst

devlib
======

``devlib`` exposes an interface for interacting with and collecting
measurements from a variety of devices (such as mobile phones, tablets and
development boards) running a Linux-based operating system.


Installation
------------

::

        sudo -H pip install devlib


Dependencies
------------

``devlib`` should install all dependencies automatically, however if you run
into issues please ensure you are using that latest version of pip.

On some systems there may additional steps required to install the dependency
``paramiko`` please consult the `module documentation <http://www.paramiko.org/installing.html>`_
for more information.

Usage
-----

Please refer  to the "Overview" section of the `documentation <http://devlib.readthedocs.io/en/latest/>`_.


License
-------

This package is distributed under `Apache v2.0 License <http://www.apache.org/licenses/LICENSE-2.0>`_. 


Feedback, Contrubutions and Support
-----------------------------------

- Please use the GitHub Issue Tracker associated with this repository for
  feedback.
- ARM licensees may contact ARM directly via their partner managers.
- We welcome code contributions via GitHub Pull requests. Please try to
  stick to the style in the rest of the code for your contributions.