prezzemolo

Prezzemolo v0.0.4

Table of Contents

• Introduction
• License
• Download
• Installation
  • Ubuntu Linux
  • macOS
  • Windows 10
  • Other Unix-like Systems
• Reporting Bugs
• Contributing
• Developer Documentation
• Frequently Asked Questions
• Change Log

Introduction

Prezzemolo is a collection of classic data structure and algorithms that are useful in many different projects. The goal is to provide components that are robust, efficient and small (in decreasing order of importance). Each component has extensive unit testing to reduce the risk of regression. The project will grow organically as new components are needed in various projects, such as RP2 (the privacy-focused, open-source crypto tax calculator), and others.

IMPORTANT DISCLAIMERS:

• Prezzemolo offers no guarantee of correctness (read the license).

License

Prezzemolo is released under the terms of Apache License Version 2.0. For more information see LICENSE or http://www.apache.org/licenses/LICENSE-2.0.

Download

The latest version of Prezzemolo can be downloaded at: https://pypi.org/project/prezzemolo/

Installation

Prezzemolo has been tested on Ubuntu Linux, macOS and Windows 10 but it should work on all systems that have Python version 3.7.0 or greater.

Installation on Ubuntu Linux

Open a terminal window and enter the following commands:

sudo apt-get update
sudo apt-get install python3 python3-pip

Then install Prezzemolo:

pip install prezzemolo

Installation on macOS

First make sure Homebrew is installed, then open a terminal window and enter the following commands:

brew update
brew install python3

Then install Prezzemolo:

pip install prezzemolo

Installation on Windows 10

First make sure Python 3.7 or greater is installed (in the Python installer window be sure to click on "Add Python to PATH"), then open a PowerShell window and enter the following:

pip install prezzemolo

Installation on Other Unix-like Systems

• install python 3.7 or greater
• install pip3
• pip install prezzemolo

Reporting Bugs

Read the Contributing document.

Contributing

Read the Contributing document.

Developer Documentation

Read the developer documentation.

Frequently Asked Questions

Read the user FAQ list and the developer FAQ list.

Change Log

Read the Change Log document.

Prezzemolo Change Log

0.0.4

• Added Dijkstra to Graph class

0.0.3

• Manage py.typed to setup.cfg options.package_data

0.0.2

• Added py.typed

0.0.1

• First version tracked in change log
• implemented Graph and Vertex classes with respective unit tests
• moved avl_tree.py from RP2
• moved to_string from RP2