Skip to main content

A headless login / logout script for 10.0.0.55

Project description

bitsrun

Ruff Pre-commit PyPI Publish PyPI PyPI - Python Version PyPI - Downloads

A headless login / logout script for 10.0.0.55 at BIT.

Install

You need at least Python 3.8. We recommend installing with pipx.

python3 -m pip install --user pipx
python3 -m pipx ensurepath

After which, install bitsrun with pipx.

pipx install bitsrun

Usage

CLI

Check login status of your device.

bitsrun status

Usage: bitsrun status [OPTIONS]

  Check current network login status.

Options:
  --json / --no-json  Output in JSON format.
  --help  Show this message and exit.

Note: this is the output of bitsrun status --help.

Login or logout with your username and password.

bitsrun login

Usage: bitsrun login/logout [OPTIONS]

  Log into or out of the BIT network.

Options:
  -u, --username TEXT  Your username.
  -p, --password TEXT  Your password.
  -v, --verbose        Verbosely echo API response.
  --help               Show this message and exit.

Note: this is the output of bitsrun login/logout --help.

Configuration file

Create new file named bit-user.json:

{
    "username": "xxxx",
    "password": "xxxx"
}

This file should be put under the following directory:

  • Windows: %APPDATA%\bitsrun
  • macOS and Linux: ~/.config/bitsrun (Following the XDG spec)

Now you can simply call:

bitsrun login
bitsrun logout

Besides, a system-wide configuration file is supported, and the location also depends on your platform.

To list all possible paths for your system (including those only for backward compatibility), call:

bitsrun config-paths

Raycast script (macOS)

raycast screenshot

Import the two Raycast scripts from ./scripts and setup your config file in ~/.config/bit-user.json. The script uses /usr/bin/python3 by default, so you either need to install bitsrun with this Python interpreter or setup your own Python interpreter path in the script.

Developing

Create virtual environment and install deps:

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -e .

Running CLI entry:

python src/bitsrun/cli.py

Build:

pip install setuptools build
python -m build

Credits

License

WTFPL License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bitsrun-3.6.0.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

bitsrun-3.6.0-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file bitsrun-3.6.0.tar.gz.

File metadata

  • Download URL: bitsrun-3.6.0.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for bitsrun-3.6.0.tar.gz
Algorithm Hash digest
SHA256 161d044dcb4e969ab7503832cc48dfd8b36ae69fec785532033f2109ca3b0d7f
MD5 d7f0e7a031fc0de770df7ac89aa77aeb
BLAKE2b-256 f892be4955ec0050f2d91763fff1c57be448edf4a756375b794069ac286d0de3

See more details on using hashes here.

Provenance

File details

Details for the file bitsrun-3.6.0-py3-none-any.whl.

File metadata

  • Download URL: bitsrun-3.6.0-py3-none-any.whl
  • Upload date:
  • Size: 10.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for bitsrun-3.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d41b9bd01168eaf4dcd1f9ef24b1113b45f82abaef80b1577ae1c0743ac61f54
MD5 cb942c7accf3f6f2cfc69fb0f84aa619
BLAKE2b-256 6223b574970451535ad0e662bde40752d243e220951a0b308bb110d10a568740

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page