Skip to main content

backport of pprint from python 3.11

Project description

pprint3x

Version v1.0.0 as of 2021-12-30 see Changelog

build_badge license jupyter pypi black

codecov better_code Maintainability Maintainability Code Coverage snyk

backport of python3.10.1 module “pprint” for python 3.6 … 3.10

this is, to support the “sort_dicts=False” parameter on older python versions.


automated tests, Travis Matrix, Documentation, Badges, etc. are managed with PizzaCutter (cookiecutter on steroids)

Python version required: 3.6.0 or newer

tested on recent linux with python 3.6, 3.7, 3.8, 3.9, 3.10.0, pypy-3.8 - architectures: amd64

100% code coverage, flake8 style checking ,mypy static type checking ,tested under Linux, macOS, Windows, automatic daily builds and monitoring



Try it Online

You might try it right away in Jupyter Notebook by using the “launch binder” badge, or click here

Usage

for documentation see : https://docs.python.org/3/library/pprint.html

and select Python Version 3.10.1

Usage from Commandline

Usage: pprint3x [OPTIONS] COMMAND [ARGS]...

  backport of pprint from python 3.11

Options:
  --version                     Show the version and exit.
  --traceback / --no-traceback  return traceback information on cli
  -h, --help                    Show this message and exit.

Commands:
  info  get program informations

Installation and Upgrade

  • Before You start, its highly recommended to update pip and setup tools:

python -m pip --upgrade pip
python -m pip --upgrade setuptools
  • to install the latest release from PyPi via pip (recommended):

python -m pip install --upgrade pprint3x
  • to install the latest version from github via pip:

python -m pip install --upgrade git+https://github.com/bitranox/pprint3x.git
  • include it into Your requirements.txt:

# Insert following line in Your requirements.txt:
# for the latest Release on pypi:
pprint3x

# for the latest development version :
pprint3x @ git+https://github.com/bitranox/pprint3x.git

# to install and upgrade all modules mentioned in requirements.txt:
python -m pip install --upgrade -r /<path>/requirements.txt
  • to install the latest development version from source code:

# cd ~
$ git clone https://github.com/bitranox/pprint3x.git
$ cd pprint3x
python setup.py install
  • via makefile: makefiles are a very convenient way to install. Here we can do much more, like installing virtual environments, clean caches and so on.

# from Your shell's homedirectory:
$ git clone https://github.com/bitranox/pprint3x.git
$ cd pprint3x

# to run the tests:
$ make test

# to install the package
$ make install

# to clean the package
$ make clean

# uninstall the package
$ make uninstall

Requirements

following modules will be automatically installed :

## Project Requirements
click
cli_exit_tools
dataclasses; python_version < '3.7'
lib_detect_testenv

Acknowledgements

  • special thanks to “uncle bob” Robert C. Martin, especially for his books on “clean code” and “clean architecture”

Contribute

I would love for you to fork and send me pull request for this project. - please Contribute

License

This software is licensed under the MIT license

Changelog

  • new MAJOR version for incompatible API changes,

  • new MINOR version for added functionality in a backwards compatible manner

  • new PATCH version for backwards compatible bug fixes

v1.0.0

2021-12-30: initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pprint3x-1.0.0.tar.gz (15.3 kB view hashes)

Uploaded Source

Built Distributions

pprint3x-1.0.0-py3.10.egg (21.7 kB view hashes)

Uploaded Source

pprint3x-1.0.0-py3.9.egg (21.6 kB view hashes)

Uploaded Source

pprint3x-1.0.0-py3.8.egg (21.7 kB view hashes)

Uploaded Source

pprint3x-1.0.0-py3.7.egg (21.6 kB view hashes)

Uploaded Source

pprint3x-1.0.0-py3.6.egg (21.6 kB view hashes)

Uploaded Source

pprint3x-1.0.0-py3-none-any.whl (12.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page