Arrr! What Ye Be Needin'
Before ye set sail, make sure yer ship has these aboard:
- Python 3.8 or higher (no rusty old versions, matey!)
- The mighty requests library
How t' Hoist the Sails (Installin')
To plunder the latest stable release from PyPI, run this in yer terminal:
# Fer Unix / macOS buccaneers
python3 -m pip install "pirate.py"
# Fer Windows deckhands
py -m pip install "pirate.py"
python3 -m pip install "pirate.py"
# Fer Windows deckhands
py -m pip install "pirate.py"
If ye want the freshest code from the captain's quarters (development version):
git clone https://github.com/Ombucha/pirate.py
cd pirate.py
pip install -e .
cd pirate.py
pip install -e .
Quick Start Fer Landlubbers
Here be how ye use this treasure:
import pirate
# Hurl a pirate insult at yer foes!
print(pirate.insult()) # "We'll keel-haul ye, ye fish-kissin', scallywagging monkey! ... Ahoy!"
# Turn yer plain English into Pirate Speak!
print(pirate.translate("Hand over the treasure, or you'll be walking the plank!")) # "Hand o'er the treasure, or ye'll be walkin' the plank!"
# Hurl a pirate insult at yer foes!
print(pirate.insult()) # "We'll keel-haul ye, ye fish-kissin', scallywagging monkey! ... Ahoy!"
# Turn yer plain English into Pirate Speak!
print(pirate.translate("Hand over the treasure, or you'll be walking the plank!")) # "Hand o'er the treasure, or ye'll be walkin' the plank!"
Links t' Treasure Maps
- Pirate Monkeyness -- The mystical source o' pirate wisdom!
- Documentation -- The ship's logs, fer those who read.
Fair winds and happy plunderin', matey!