---

cdisutils

Various utilities useful for working on cdis systems.

• cdisutils
  • cdisutils.net
    • no_proxy
  • cdisutils.storage3
    • is_probably_swift_segments(obj)
    • swift_stream(obj)
  • cdisutils.log
    • get_logger(name)
  • cdisutils.tungsten
• Setup pre-commit hook to check for secrets
• contributing

---

A few modules:

cdisutils.net

Networking utilities.

no_proxy

function that can be used as a decorator or a context manager to temporarily disable the pdc http_proxy

cdisutils.storage3

For working with storage via apache libcloud

is_probably_swift_segments(obj)

Takes a libcloud storage Object, tells you if it's probably one of OpenStack Swift's goofy segment indicator JSON blobs

swift_stream(obj)

Given a libcloud storage object containing one of the aforementioned JSON blobs, gives you a stream to the data you actually wanted.

cdisutils.log

Simple logging setup.

get_logger(name)

Returns a basic stdlib Logger object that logs to stdout with a reasonable format string, set to level INFO.

cdisutils.tungsten

Utilities for working with tungsten provisioned machines

Setup pre-commit hook to check for secrets

We use pre-commit to setup pre-commit hooks for this repo. We use detect-secrets to search for secrets being committed into the repo.

To install the pre-commit hook, run

pre-commit install

To update the .secrets.baseline file run

detect-secrets scan --update .secrets.baseline

.secrets.baseline contains all the string that were caught by detect-secrets but are not stored in plain text. Audit the baseline to view the secrets .

detect-secrets audit .secrets.baseline

contributing

Read how to contribute here