Skip to main content

A headless login / logout script for 10.0.0.55

Project description

bitsrun

Ruff pdm-managed 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

Install and run:

# Create virtual env and install deps
pdm install

# Enter virtual env
eval $(pdm venv activate)

# Install pre-commit hooks
pre-commit install

Build:

pdm build

Publish:

pdm publish

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.5.1.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

bitsrun-3.5.1-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for bitsrun-3.5.1.tar.gz
Algorithm Hash digest
SHA256 5ec1d7d01e74ca7f2a53b916f6f4e9519db6571c5c2417a9ba3a52c1f2c4c0c4
MD5 1102eee99ec8dc2c8afa5d20bd363681
BLAKE2b-256 5f15a948182b8b22d28fc7bc1f20e589d094dd4678cf23321a399f059f4f7cee

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for bitsrun-3.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ab3563b7e407c0a3bda01afbbafb9a9f9cdf7b4ce7af4351cab33afe76713073
MD5 5d6741dc00fc5a36295e92a76e3dc147
BLAKE2b-256 13d9aac0b127a0c7e21a7ca11d2ad1c1b305b26b8b2cf569b40adf76bff4059f

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