trueupdate -> TrueTool
This commit is contained in:
parent
7f8f523fca
commit
779b632835
25
README.md
25
README.md
@ -1,28 +1,29 @@
|
|||||||
# trueupdate
|
# truetool
|
||||||
A TrueCharts automatic and bulk update utility
|
A easy tool for frequently used TrueNAS SCALE CLI utilities.
|
||||||
|
Previously known as "trueupdate"
|
||||||
|
|
||||||
## How to install
|
## How to install
|
||||||
|
|
||||||
run `pip install trueupdate`
|
run `pip install truetool`
|
||||||
|
|
||||||
Please be aware you will need to reinstall after every SCALE update
|
Please be aware you will need to reinstall after every SCALE update
|
||||||
|
|
||||||
## How to Update
|
## How to Update
|
||||||
|
|
||||||
run `pip install --upgrade trueupdate`
|
run `pip install --upgrade truetool`
|
||||||
|
|
||||||
## How to use
|
## 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:
|
Additional options are available:
|
||||||
|
|
||||||
- `trueupdate --catalog CATALOGNAME` where CATALOGNAME is the name of the catalog you want to process in caps
|
- `truetool --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 --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
|
- `truetool -h` for the CLI help page
|
||||||
- `trueupdate -s` or ` trueupdate --sync` to sync the catalogs before running auto-update
|
- `truetool -s` or ` truetool --sync` to sync the catalogs before running auto-update
|
||||||
- `trueupdate -p` or ` trueupdate --prune` to prune (remove) old docker images after running auto-update
|
- `truetool -p` or ` truetool --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
|
- `truetool -a` or ` truetool --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
|
- `truetool -b` or ` truetool --backup` backup the complete Apps system prior to updates
|
10
setup.py
10
setup.py
@ -6,8 +6,8 @@ from os.path import abspath, dirname, join
|
|||||||
README_MD = open(join(dirname(abspath(__file__)), "README.md")).read()
|
README_MD = open(join(dirname(abspath(__file__)), "README.md")).read()
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name="trueupdate",
|
name="truetool",
|
||||||
version="2.3.0",
|
version="1.0.0",
|
||||||
|
|
||||||
# The packages that constitute your project.
|
# The packages that constitute your project.
|
||||||
# For my project, I have only one - "pydash".
|
# For my project, I have only one - "pydash".
|
||||||
@ -20,13 +20,13 @@ setup(
|
|||||||
packages=find_packages(),
|
packages=find_packages(),
|
||||||
|
|
||||||
entry_points = {
|
entry_points = {
|
||||||
'console_scripts': ['trueupdate=trueupdate.command_line:main'],
|
'console_scripts': ['truetool=truetool.command_line:main'],
|
||||||
},
|
},
|
||||||
|
|
||||||
# The description that will be shown on PyPI.
|
# The description that will be shown on PyPI.
|
||||||
# Keep it short and concise
|
# Keep it short and concise
|
||||||
# This field is OPTIONAL
|
# 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.
|
# The content that will be shown on your project page.
|
||||||
# In this case, we're displaying whatever is there in our README.md file
|
# 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
|
# 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.
|
# or the project's documentation. I'll leave a link to this project's Github repository.
|
||||||
# This field is OPTIONAL
|
# 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.
|
# The author name and email fields are self explanatory.
|
||||||
# These fields are OPTIONAL
|
# These fields are OPTIONAL
|
||||||
|
4
truetool/command_line.py
Normal file
4
truetool/command_line.py
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
import truetool
|
||||||
|
|
||||||
|
def main():
|
||||||
|
truetool.run()
|
@ -1,4 +0,0 @@
|
|||||||
import trueupdate
|
|
||||||
|
|
||||||
def main():
|
|
||||||
trueupdate.run()
|
|
Loading…
Reference in New Issue
Block a user