A small utility package
Project description
Common Utils
TODOs
- Use own
Logger
once the class is finalized in all scripts.
Continuous Integration
Virtual Environment
First, make a virtual environment with make_venv.sh
:
curl -s -o make_venv.sh \
https://raw.githubusercontent.com/gao-hongnan/common-utils/main/scripts/devops/make_venv.sh && \
bash make_venv.sh venv --pyproject --dev && \
source venv/bin/activate && \
rm make_venv.sh
Continue on error vs If Always
See here.
Run Bandit Security Check
bash ./scripts/devops/ci/ci_security_bandit.sh \
--severity-level=low \
--format=json \
--output=bandit_results.json \
common_utils
Run Linter Check
bash ./scripts/devops/ci/ci_linter_pylint.sh \
--rcfile=pyproject.toml \
--fail-under=10 \
--score=yes \
--output-format=json:pylint_results.json,colorized \
common_utils
Run Formatter Black Check
bash ./scripts/devops/ci/ci_formatter_black.sh \
--check \
--diff \
--color \
--verbose \
common_utils
Run Formatter Isort Check
bash ./scripts/devops/ci/ci_formatter_isort.sh \
--check \
--diff \
--color \
--verbose \
common_utils
Run MyPy Type Check
bash ./scripts/devops/ci/ci_typing_mypy.sh \
--config-file=pyproject.toml \
common_utils \
| tee mypy_results.log
Run Unit Test
Run Integration Test
Run System Test
Run Acceptance Test
See madewithml.
Run Data Test (Great Expectations)
Run Markdown Lint
npm install -g markdownlint-cli && \
touch .markdownlint.json && \
npm install --save-dev --save-exact prettier
# prettier
function pr() {
if [ -z "$1" ]; then
echo "Error: TARGET_DIR is mandatory."
return 1
fi
TARGET_DIR="$1"
prettier "$TARGET_DIR" --write \
--prose-wrap always \
--print-width 80 \
--tab-width 4 \
--use-tabs true
}
pr <TARGET_MARKDOWN_FILE>
markdownlint --fix <TARGET_MARKDOWN_FILE>
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gaohn-common-utils-0.0.80.tar.gz
(26.4 kB
view hashes)
Built Distribution
Close
Hashes for gaohn-common-utils-0.0.80.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10edef542e76da09c53bcb1985a2cb72e31f11ca9809656be3439e09bd290efd |
|
MD5 | 53c4acb37cd128783e4986900494a327 |
|
BLAKE2b-256 | 868efa812c30b2e0902d749490bd490905d4a0626af07546916f5d9ec01bbc41 |
Close
Hashes for gaohn_common_utils-0.0.80-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 826855c97576b0b828156e25821831ee10938ed541163a499b0f1d5104c5cdd7 |
|
MD5 | c608648af22ab80d4dc4f08838216515 |
|
BLAKE2b-256 | 59c561dd002f1aad8f2ed7483867c7e01f78b342890eac5bea78dd21b398fc58 |