diff --git a/README.md b/README.md index 103f946c..281d5f99 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,29 @@ -# trueupdate -A TrueCharts automatic and bulk update utility +# truetool +A easy tool for frequently used TrueNAS SCALE CLI utilities. +Previously known as "trueupdate" ## How to install -run `pip install trueupdate` +run `pip install truetool` Please be aware you will need to reinstall after every SCALE update ## How to Update -run `pip install --upgrade trueupdate` +run `pip install --upgrade truetool` ## How to use -Just run `trueupdate` in the shell of your TrueNAS SCALE machine, to have it process Patch and Minor version updates for all Apps +Just run `truetool` in the shell of your TrueNAS SCALE machine, to have it process Patch and Minor version updates for all Apps Additional options are available: -- `trueupdate --catalog CATALOGNAME` where CATALOGNAME is the name of the catalog you want to process in caps -- `trueupdate --versioning SCHEME` where SCHEME is the highest semver version you want to process. options: `patch`, `minor` and `major` +- `truetool --catalog CATALOGNAME` where CATALOGNAME is the name of the catalog you want to process in caps +- `truetool --versioning SCHEME` where SCHEME is the highest semver version you want to process. options: `patch`, `minor` and `major` -- `trueupdate -h` for the CLI help page -- `trueupdate -s` or ` trueupdate --sync` to sync the catalogs before running auto-update -- `trueupdate -p` or ` trueupdate --prune` to prune (remove) old docker images after running auto-update -- `trueupdate -a` or ` trueupdate --all` updates both active (running) and non-active (stuck or stopped) Apps -- `trueupdate -b` or ` trueupdate --backup` backup the complete Apps system prior to updates \ No newline at end of file +- `truetool -h` for the CLI help page +- `truetool -s` or ` truetool --sync` to sync the catalogs before running auto-update +- `truetool -p` or ` truetool --prune` to prune (remove) old docker images after running auto-update +- `truetool -a` or ` truetool --all` updates both active (running) and non-active (stuck or stopped) Apps +- `truetool -b` or ` truetool --backup` backup the complete Apps system prior to updates \ No newline at end of file diff --git a/setup.py b/setup.py index 3c64073a..8c8904e6 100644 --- a/setup.py +++ b/setup.py @@ -6,8 +6,8 @@ from os.path import abspath, dirname, join README_MD = open(join(dirname(abspath(__file__)), "README.md")).read() setup( - name="trueupdate", - version="2.3.0", + name="truetool", + version="1.0.0", # The packages that constitute your project. # For my project, I have only one - "pydash". @@ -20,13 +20,13 @@ setup( packages=find_packages(), entry_points = { - 'console_scripts': ['trueupdate=trueupdate.command_line:main'], + 'console_scripts': ['truetool=truetool.command_line:main'], }, # The description that will be shown on PyPI. # Keep it short and concise # This field is OPTIONAL - description="An Automatic and Bulk update utility for TrueNAS SCALE Apps", + description="An easy utility to managed frequently used TrueNAS SCALE CLI features", # The content that will be shown on your project page. # In this case, we're displaying whatever is there in our README.md file @@ -43,7 +43,7 @@ setup( # The url field should contain a link to a git repository, the project's website # or the project's documentation. I'll leave a link to this project's Github repository. # This field is OPTIONAL - url="https://github.com/truecharts/trueupdate", + url="https://github.com/truecharts/truetool", # The author name and email fields are self explanatory. # These fields are OPTIONAL diff --git a/trueupdate/__init__.py b/truetool/__init__.py similarity index 100% rename from trueupdate/__init__.py rename to truetool/__init__.py diff --git a/truetool/command_line.py b/truetool/command_line.py new file mode 100644 index 00000000..33e703bc --- /dev/null +++ b/truetool/command_line.py @@ -0,0 +1,4 @@ +import truetool + +def main(): + truetool.run() \ No newline at end of file diff --git a/trueupdate/command_line.py b/trueupdate/command_line.py deleted file mode 100644 index 61007677..00000000 --- a/trueupdate/command_line.py +++ /dev/null @@ -1,4 +0,0 @@ -import trueupdate - -def main(): - trueupdate.run() \ No newline at end of file