https://github.com/advrhumanoids/xbot2_cli

Command line interface for xbot2

https://github.com/advrhumanoids/xbot2_cli

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.5%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Command line interface for xbot2

Basic Info
  • Host: GitHub
  • Owner: ADVRHumanoids
  • Language: Python
  • Default Branch: master
  • Size: 43.9 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme

README.md

xbot2_cli

xbot2_cli is a command-line interface (CLI) application designed to provide an easy way to interact with the XBot framework.

Setup

Prerequisites

```bash

install system dependencies

sudo apt update sudo apt install python3-pip python3-venv

create a virtualenv for this package (mandatory on Python >= 3.12)

cd xbot2cli python3 -m venv venv/xbot2cli source venv/xbot2_cli/bin/activate ```

Installing the package

To install xbot2_cli, you can use pip. Make sure you have sourced your virtualenv, then run:

bash pip install -e .

This will install the package along with its dependencies.

Tab completion is supported via running the following line in your shell.

bash echo eval \"\$(register-python-argcomplete xbot2)\" >> ~/.bashrc

Usage

Make sure you sourced the virtualenv; you can run the CLI by executing the following command in your terminal:

bash xbot2

You can view the available commands and options by using the --help flag:

bash xbot2 --help

Examples

```bash

list available plugins, optionally with their current status

xbot2 plugin list xbot2 plugin list --status

start a plugin

xbot2 plugin switch homing start

set filters cutoff freq

xbot2 filter set 10.0

disable filter

xbot2 filter enable false

watch execution statustics (refreshed every half second)

xbot2 watch stats -n 0.5

clear the internal cache (this is used to avoid querying xbot2 for params and plugins on each TAB press)

xbot2 clear ```

Owner

  • Name: ADVR Humanoids
  • Login: ADVRHumanoids
  • Kind: organization
  • Email: luca.muratore@iit.it
  • Location: Istituto Italiano di Tecnologia

Humanoids & Human Centered Mechatronics, HHCM, IIT

GitHub Events

Total
  • Push event: 9
  • Create event: 2
Last Year
  • Push event: 9
  • Create event: 2

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 12
  • Total Committers: 2
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.083
Past Year
  • Commits: 12
  • Committers: 2
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.083
Top Committers
Name Email Commits
Arturo Laurenzi a****i@i****t 11
Ioannis Dadiotis i****s@i****t 1
Committer Domains (Top 20 + Academic)
iit.it: 2

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

setup.py pypi