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.79.tar.gz
(26.4 kB
view hashes)
Built Distribution
Close
Hashes for gaohn-common-utils-0.0.79.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 209dfa7236dc694220e5faf5b1c9e05b54cf7cc29550c4dacac2b3f8d5bd4f97 |
|
MD5 | 4f53df09b2eba14292b08264c9c996fe |
|
BLAKE2b-256 | 249f04871804cc33f0b62a47dd957869ae74f450b1934e6e82647c0b77d43ffc |
Close
Hashes for gaohn_common_utils-0.0.79-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83f5ec1c04ffb9eb9c261f5c8904a1b4be3adb7c26b2cdecb51381bb6bac6de2 |
|
MD5 | fdd0041eed9e74a2aed1b83daa792c00 |
|
BLAKE2b-256 | 38dfd18ad98dd392830eeb1639fa5d4752178aeb7002e62ab8d13bb08e8dbf77 |