(pre-release) PagerDuty Public Support Scripts CLI App
Project description
Automatic Dev Docs
Installation & Use (note: Pre-Release)
Install:
pip install pdsupp_cli
Use:
pspdbeta --help
Goal:
1
Move the hard work represented in PagerDuty Public Support Scripts to an accessible, user-friendly, but low-maintenance CLI framework.
Offer basic help, parsing, and a pip install ...
option for users.
2
Add unit and integration tests to the varous script conversions to make extension and maintenance feel (and be) safer!
3
Add developer documentation (alongside auto-doc publication and in-IDE registration) to the scripts to make maintenance and extension (and inspiration) more fun and efficient!
4
Offer a learning project to share with anyone who wants to work with CLI apps, small-scale automated CI/CD processes, and modern Python idioms.
General Repo characteristics:
Python Skeleton Repo
This repo is derived from an in-progress Python+Poetry Skeleton. All code there is functional. However some knowledge of what variables to populate is still required.
Supported Virtual Environoment, Dependency, and Publication Mgmgt Environment:
This repo is designed for use with the Poetry environment. The code it runs assumes that .venv's are local. Set with:
poetry config virtualenvs.in-project true
Check with:
poetry config --list
The repo also uses pre-commit hooks (download separately, as .git/
is not automatically synched) that auto-populate a requirements.txt
& requirements-dev.txt
so Poetry is NOT required for building and exploration. (However the CI/CD scripts will use the Poetry system.)
Dev-Dependencies Specified
- formatting:
isort
&black
- linting:
pylint
- lsp & typechecking:
pyright
- testing:
pytest
+coverage
(viapytest-cov
) - auto-documentation:
pdoc
(not"pdoc3", which should be strongly avoided)
Run Pre-Commit Hook Manually
from anywhere in project:
git hook run pre-commit
Note:
Due to runner environment caching in GitHub Workflow environment renaming needs to be accompanied by explicit cache deletion. And possible other maintenance.
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
Built Distribution
Hashes for pdsupp_cli-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d0277ba2bffdf52767e6042b1bbad1b0c5dc684e75eba926bcda1a62a781df2 |
|
MD5 | 52bb6fa8f99d812b9cca30293edaf51f |
|
BLAKE2b-256 | 72ac9f73a11c3506ab4fcbb48c8b2484ef6abc7856a1cc7bb5e6f16c3914ecd1 |