This repository has been archived on 2023-03-26. You can view files and clone it, but cannot push or open issues or pull requests.
Printr/README.md

24 lines
846 B
Markdown
Raw Normal View History

2015-09-26 15:21:57 +01:00
# Printr
Printr is a simple PyPi module that allows for print statements to be replaces with a new line. Particularly useful for displaying progress messages.
2015-09-26 15:56:55 +01:00
## Installation
2015-09-28 21:05:31 +01:00
Installation can be done using pip in the standard way:
2015-09-26 15:56:55 +01:00
```
pip install python-printr
```
If you have python 3 installed, then install using `pip3`. There are no dependancies for this package, so installation should go ahead fine.
2015-09-28 21:05:31 +01:00
Alternatively, you can download directly from Pypi [here](https://pypi.python.org/pypi/Python-Printr/).
2015-09-26 15:56:55 +01:00
2015-09-28 21:05:31 +01:00
## Usage
```
import printr
printr.get_version()
2015-10-08 22:25:40 +01:00
>>> 0.0.3
2015-09-28 21:05:31 +01:00
```
2015-10-08 22:25:40 +01:00
The printr module contains various different printrs to assist you. You can find more information about these printrs on the wiki.
The main reason I wrote this project was to simplify status output for my projects, and because I'd never written a PyPi package before.