Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waikato-datamining/docker-banner-gen
Command-line tool for generating bash.bashrc templates for docker with a custom banner.
https://github.com/waikato-datamining/docker-banner-gen
bash bashrc docker python3
Last synced: 5 days ago
JSON representation
Command-line tool for generating bash.bashrc templates for docker with a custom banner.
- Host: GitHub
- URL: https://github.com/waikato-datamining/docker-banner-gen
- Owner: waikato-datamining
- License: apache-2.0
- Created: 2020-06-06T21:11:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T04:50:31.000Z (7 months ago)
- Last Synced: 2024-10-31T19:58:46.278Z (13 days ago)
- Topics: bash, bashrc, docker, python3
- Language: Python
- Homepage:
- Size: 33.2 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
# docker-banner-gen
The **docker-banner-gen** command-line tool allows you to generate
`bash.bashrc` files to be used within Docker containers.
It is based on TensorFlow's `bash.bashrc` and uses pyfiglet to
generate the banner.
## Installation
You can install the tool with `pip` as follows (best to install it in a [virtual
environment](https://virtualenv.pypa.io/en/latest/)):
```commandline
pip install docker-banner-gen
```
Or download and install a Debian package, if you are running Debian/Ubuntu.
## Usage
```
usage: docker-banner-gen [-h] [-t FILE] [-b TEXT] [-s TEXT] [-f FONT]
[-p TEXT] [-w COLS] [-o FILE] [-i] [-L] [-F FONT]
Generates bash.bashrc templates for docker with a custom banner (ASCII art via
pyfiglet).
optional arguments:
-h, --help show this help message and exit
-t FILE, --template FILE
The banner template to use if not using the built-in
one; use placeholders {BANNER} and {PS1} in the
template. (default: None)
-b TEXT, --banner TEXT
The text to use for the banner (processed by
pyfiglet). Use the string '\n' (not the newline
character) to signal a line-break in the banner text.
(default: Banner)
-s TEXT, --subtitle TEXT
The subtitle text to use below the banner (regular
text), e.g., a version number. (default: None)
-f FONT, --font FONT The figlet font to use for generating the banner.
(default: standard)
-p TEXT, --ps1 TEXT The text to use in the PS1 environment variable (used
in the prompt). (default: docker)
-w COLS, --width COLS
The maximum width for the banner. (default: 80)
-o FILE, --output FILE
The file to store the generated bash.bashrc code in;
prints to stdout if not provided. (default: None)
-i, --print_templates
Outputs the default templates to stdout. (default:
False)
-L, --list_fonts Outputs the available fonts. (default: False)
-F FONT, --print_font_info FONT
Outputs information about the specified font.
(default: None)
```
## Example
Using the following command-line:
```commandline
docker-banner-gen \
-b "TF ObjDet" \
-s 1.14.0_2019-08-31 \
-p tf-objdet \
-o $HOME/bash.bashrc
```
The generated `$HOME/bash.bashrc` file looks like this:
```bash
# Copyright 2018 The TensorFlow Authors. All Rights Reserved.
# Copyright 2020 University of Waikato, Hamilton, NZ. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# ==============================================================================
export PS1="\[\e[31m\]tf-objdet\[\e[m\] \[\e[33m\]\w\[\e[m\] > "
export TERM=xterm-256color
alias grep="grep --color=auto"
alias ls="ls --color=auto"
echo -e "\e[1;31m"
cat<
```
* running as regular user
```
_____ _____ ___ _ _ ____ _
|_ _| ___| / _ \| |__ (_) _ \ ___| |_
| | | |_ | | | | '_ \| | | | |/ _ \ __|
| | | _| | |_| | |_) | | |_| | __/ |_
|_| |_| \___/|_.__// |____/ \___|\__|
|__/
1.14.0_2019-08-31
You are running this container as user with ID 12345 and group 12345,
which should map to the ID and group for your user on the Docker host. Great!
tf-objdet / >
```