Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A python package that pretty prints Python objects with colors and proper indentation.

Project description

Amazing Printer

Build Status codecov

It's an attempt to port the Ruby's awesome_print to Python.

the-pitch

Install

pip install amazing-printer

Usage

from amazing_printer import ap

ap(object, options = {})

# Options:
# sort_keys - boolean, set to sort the dictionary keys, default is False.
# indent - integer, set the width of indentation, default is 4 spaces.
# multiple_lines - boolean, set to print the fields for dict or list in multiple lines, default is True.
# color - dict, set the color for different literals, default is
# {
#     'str': 'yellow',
#     'list': 'blue',
#     'tuple': 'green',
#     'none': 'red',
# }
# supported colors: 'yellow', 'blue', 'green', 'red', 'black', 'magenta', 'cyan', 'white'

Contributing

  1. Fork & clone the repository
$ git clone git@github.com:<your-github-handle>/amazing_printer.git
$ cd amazing_printer
  1. Create a virtual environment and activate it' This project uses Pipenv. Follow the instruction here to install.
$ pipenv shell --three
  1. Install dependencies
# Install dependencies for development purpose.
$ pipenv install --dev
  1. Make your awesome changes

  2. Run test and coverage

# Run test
(env) $ pytest
# Run test with coverage report
(env) $ pytest --cov=amazing_printer amazing_printer/tests/
# Run specific test
(env) $ pytest -k "TestFormatter"
  1. Run test for multiple environments Make sure you have installed multiple versions of Python. Recommended way of managing Python version using Pyenv
(env) $ tox
  1. Make your pull request

License

Copyright (c) 2019 Kher Yee, Ting

Released under the MIT license. See LICENSE file for details.

Project details


Download files

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

Files for amazing-printer, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size amazing_printer-0.1.0-py3-none-any.whl (12.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page