A collection of Python common tools and facilities for connecting to databases, interacting with cloud resourecs, working with Python objects, etc.

• Tools
  • Installation
  • Environment variables
  • Development
    • IDE and environment
    • Using GitHub Actions CI
  • Versioning
  • Latest changes

NOTE: Mac users will need the pg_config binary installed via the postgresql package in Homebrew:

brew install postgresql

Add the following to requirements file of dependent projects (pyproject.toml, Pipfile, requirements.txt, etc.):

pytools = { path = "../pytools/", develop = true }

Or, if you have an internal PyPi server:

pip install -i "https://${INTERNAL_PYPI_USERNAME}:${INTERNAL_PYPI_PASS}@${INTERNAL_PYPI_URL}" pytools

# packages for file_inspect parsers for AlpineLinux

sudo apk add antiword

# packages for file_inspect parsers for Debian Linux

sudo apt install build-essential antiword

# packages for file_inspect parsers for MacOS

brew install antiword

These env variables affect tools modules:

• AWS_REGION - Region for Boto3Connect classes
• ENV - Environment for Boto3Connect classes
• DEBUG_MODE - Sets default log level to DEBUG if set to true

# for fellow VSCode users: setup formatting
pre_commit -c vscode --fix

# install pre-commit hook
pre_commit -c pre_commit --fix

# run pre_commit once to make sure that your env is ready
pre_commit

• Use GitHub releases to create a Release PR that bumps version and updates CHANGELOG.md
• Follow keep a changelog format in release and PR notes
• Do not update <package>/version.txt and CHANGELOG.md manually to avoid PR conflicts
• Run repo_checker after you edit pyproject.toml [tool.repo_checker] section

pytools version follows PEP 440.

Full changelog can be found in Changelog. Release notes can be found in Releases.