4 releases (2 breaking)
| new 0.3.1 | Nov 16, 2024 |
|---|---|
| 0.3.0 | Nov 9, 2024 |
| 0.2.0 | Nov 3, 2024 |
| 0.1.0 | Oct 23, 2024 |
#858 in Debugging
487 downloads per month
46KB
840 lines
Python client for BulletinBoard
BulletinBoard is an object strage for ArrayObject for debugging and data taking purposes.
For more details, see BulletinBoard.
Caution
- Clients do not check whether the operation is successful or not to improve performance. Check the log of the server for the errors.
- The data is not encrypted. Please do not send any confidential data over the network.
- This crate is under development and is subject to change in specification. (Compatibility across
BulletinBoardanddbgbbis ensured for the most minor version numbers.)
Install
The package can be installed via pip as
pip install bulletin-board-client
Example
To post and read the bulletins,
import bulletin_board_client as bbclient
bbclient.set_addr("192.168.0.3:7578")
bbclient.post("test", "tag", [1,2,3])
bbclient.read("test")
Compilation
This crate depends on python packages of numpy and maturin.
First, you need to clone the repository:
cargo clone bulletin-board-python
# OR
git clone https://github.com/YShoji-HEP/BulletinBoard.git
Then, go to bulletin-board-python directory and run
maturin develop -r
Functions
| Function | Description |
|---|---|
| set_addr(address) | Set the address of the server. The address is either "ADDRESS:PORT" or "SOCKETPATH". If this function is not called, the default address is "127.0.0.1:7578". |
| post(title, tag(optional), data) | Post the data to the server. title and tag are str. data can be int, float, complex, str, list or numpy.array. Here, list must be able to be comverted to numpy.array. When the tag is ommitted, it becomes Python. |
| read(title, tag=None, revisions=None) | Read the bulletin. revisions is a list of int. |
| relabel(title_from, tag_from=None, title_to=None, tag_to=None) | Relabel a bulletin. |
| client_version() | Show the version of the client. |
| server_version() | Show the version of the server. |
| status() | Show the status of the server. |
| log() | Show the log of the server. |
| view_board() | List the bulletins. |
| get_info(title, tag=None) | See the details of the bulletin. |
| clear_revisions(title, tag(optional), revisions) | Clear the specified revisions. |
| remove(title, tag=None) | Remove all revisions of the specified bulletin. |
| archive(archive_name, title, tag=None) | Save the bulletin to an archive and make the data persistent. |
| load(archive_name) | Load the archived data. (The archive name is added to the tag) |
| list_archive() | List the archives. |
| rename_archive(archive_from, archive_to) | Rename an archive. This is executed when reset is called. |
| delete_archive(archive_name) | Delete an archive. This is executed when reset is called. |
| dump(archive_name) | Save all the bulletins to an archive. |
| restore(archive_name) | Reset the server and restore the archived data. (The data is restored to memory/file without modification of the tag) |
| clear_log() | Clear the log of the server. |
| reset_server() | Reset the BulletinBoard server. |
| terminate_server() | Terminate the BulletinBoard server. |
Dependencies
~3–4.5MB
~94K SLoC