Readme

simplecalc

simplecalc is an example project to show how to set up an open source project from scratch.

Read the Blog Post

The blog talks about how this project was set up.

List of Covered Tools

Environment

• pyenv
  • pyenv-virtualenv
• poetry

Project Styling

• flake8
  • flake8-docstrings
  • darglint
• isort
  • seed-isort-config
• black
• pre-commit

Unit Testing

• pytest
  • pytest-cov
  • pytest-mock
  • xdoctest
• coverage
• tox

Continuous Integration

• Azure Pipelines

Documentation

• sphinx
• readthedocs
• sphinx_rtd_theme

Release

• towncrier
• poetry (again)

Documentation

Read the docs!

API

API Reference

Calculator

The most over-engineered calculator.

exception simplecalc.calculator.CalculatorTypeError

Custom Type Error for calculation operations.

exception simplecalc.calculator.CalculatorValueError

Custom ValueError for calculation operations.

simplecalc.calculator.difference(nums)

Find the difference of a list of numbers.

Example

>>> difference([1, 2, 3, 4])
-8

Parameters:nums (list) – A list of numbers Returns:The difference Return type:int or float

simplecalc.calculator.power(nums)

Find the power of a list of numbers.

{1}^{2}^{3}

Parameters:nums (list) – A list of numbers Returns:The power Return type:int or float

simplecalc.calculator.product(nums)

Find the product of a list of numbers.

Example

>>> product([1, 2, 3, 4])
24

Parameters:nums (list) – A list of numbers Returns:The product Return type:int or float

simplecalc.calculator.quotient(nums)

Find the quotient of a list of numbers.

Example

>>> quotient([1, 2, 3, 4])
0.041666666666666664

Parameters:nums (list) – A list of numbers Returns:The quotient Return type:int or float

simplecalc.calculator.sum_(nums)

Find the sum of a list of numbers.

Example

>>> sum_([1, 2, 3, 4])
10

Parameters:nums (list) – A list of numbers Returns:The sum Return type:int or float

Changelog

Changelog

Simplecalc 0.2 (2019-11-25)

No significant changes.

Simplecalc 0.1.0 (2019-07-25)

Features

• Initial release. (#2)

Indices and tables

• Index
• Module Index
• Search Page