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:
  --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.4.1.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

bitsrun-3.4.1-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for bitsrun-3.4.1.tar.gz
Algorithm Hash digest
SHA256 c4edf83df2d56a063184bc03f4b0c15e07cf9a8a5f2679e344c1922ed728d787
MD5 1020802b889c983957a0d6dbe138976d
BLAKE2b-256 00b7059d1c4fca0d625a1ff38f2a38d8f8aa4357335b4092394ec3d9921f80be

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for bitsrun-3.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3c9a1ca176fd011288dfee94708a76a144c5a3a8cdc563d14b217da4ad91eb08
MD5 4883d771a05d37f704b0a6557e1e5a5c
BLAKE2b-256 01dbebb7cb55a880c660b45b3a818d9db3a382e852d583834eb4abc112698e1d

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