# The MIT License (MIT)
# Copyright © 2021 Yuma Rao
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
# documentation files (the “Software”), to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in all copies or substantial portions of
# the Software.
# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
# THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
import os
import argparse
import bittensor
from rich.prompt import Prompt
from rich.table import Table
console = bittensor.__console__
[docs]
class UpdateCommand:
"""
Executes the ``update`` command to update the local Bittensor package.
This command performs a series of operations to ensure that the user's local Bittensor installation is updated to the latest version from the master branch of its GitHub repository. It primarily involves pulling the latest changes from the repository and reinstalling the package.
Usage:
Upon invocation, the command first checks the user's configuration for the ``no_prompt`` setting. If ``no_prompt`` is set to ``True``, or if the user explicitly confirms with ``Y`` when prompted, the command proceeds to update the local Bittensor package. It changes the current directory to the Bittensor package directory, checks out the master branch of the Bittensor repository, pulls the latest changes, and then reinstalls the package using ``pip``.
The command structure is as follows:
1. Change directory to the Bittensor package directory.
2. Check out the master branch of the Bittensor GitHub repository.
3. Pull the latest changes with the ``--ff-only`` option to ensure a fast-forward update.
4. Reinstall the Bittensor package using pip.
Example usage::
btcli legacy update
Note:
This command is intended to be used within the Bittensor CLI to facilitate easy updates of the Bittensor package. It should be used with caution as it directly affects the local installation of the package. It is recommended to ensure that any important data or configurations are backed up before running this command.
"""
[docs]
@staticmethod
def run(cli):
if cli.config.no_prompt or cli.config.answer == "Y":
os.system(
" (cd ~/.bittensor/bittensor/ ; git checkout master ; git pull --ff-only )"
)
os.system("pip install -e ~/.bittensor/bittensor/")
[docs]
@staticmethod
def check_config(config: "bittensor.config"):
if not config.no_prompt:
answer = Prompt.ask(
"This will update the local bittensor package",
choices=["Y", "N"],
default="Y",
)
config.answer = answer
[docs]
@staticmethod
def add_args(parser: argparse.ArgumentParser):
update_parser = parser.add_parser(
"update", add_help=False, help="""Update bittensor """
)
bittensor.subtensor.add_args(update_parser)
[docs]
class AutocompleteCommand:
"""Show users how to install and run autocompletion for Bittensor CLI."""
[docs]
@staticmethod
def run(cli):
console = bittensor.__console__
shell_commands = {
"Bash": "btcli --print-completion bash >> ~/.bashrc",
"Zsh": "btcli --print-completion zsh >> ~/.zshrc",
"Tcsh": "btcli --print-completion tcsh >> ~/.tcshrc",
}
table = Table(show_header=True, header_style="bold magenta")
table.add_column("Shell", style="dim", width=12)
table.add_column("Command to Enable Autocompletion", justify="left")
for shell, command in shell_commands.items():
table.add_row(shell, command)
console.print(
"To enable autocompletion for Bittensor CLI, run the appropriate command for your shell:"
)
console.print(table)
console.print(
"\n[bold]After running the command, execute the following to apply the changes:[/bold]"
)
console.print(" [yellow]source ~/.bashrc[/yellow] # For Bash and Zsh")
console.print(" [yellow]source ~/.tcshrc[/yellow] # For Tcsh")
[docs]
@staticmethod
def add_args(parser):
parser.add_parser(
"autocomplete",
help="Instructions for enabling autocompletion for Bittensor CLI.",
)
[docs]
@staticmethod
def check_config(config):
pass
