symba

In what follows python is an alias for python3.7 or pypy3.7 or any later version (python3.8, pypy3.8 and so on).

Installation

Install the latest pip & setuptools packages versions

python -m pip install --upgrade pip setuptools

User

Download and install the latest stable version from PyPI repository

python -m pip install --upgrade symba

Developer

Download the latest version from GitHub repository

git clone https://github.com/lycantropos/symba.git
cd symba

Install dependencies

python -m pip install -r requirements.txt

Install

python setup.py install

Usage

>>> from symba.base import Expression, sqrt
>>> golden_ratio = (1 + sqrt(5)) / 2
>>> isinstance(golden_ratio, Expression)
True
>>> golden_ratio * golden_ratio == golden_ratio + 1
True
>>> 1 / golden_ratio == golden_ratio - 1
True
>>> def fibonacci(index: int) -> Expression:
...     """
...     Based on:
...     https://en.wikipedia.org/wiki/Golden_ratio#Relationship_to_Fibonacci_sequence
...     """
...     golden_ratio_power = golden_ratio ** index
...     return ((golden_ratio_power - (-1) ** index / golden_ratio_power)
...             / sqrt(5))
>>> fibonacci(0) == 0
True
>>> fibonacci(1) == 1
True
>>> fibonacci(100) == 354224848179261915075
True

Development

Bumping version

Preparation

Install bump2version.

Pre-release

Choose which version number category to bump following semver specification.

Test bumping version

bump2version --dry-run --verbose $CATEGORY

where $CATEGORY is the target version number category name, possible values are patch/minor/major.

Bump version

bump2version --verbose $CATEGORY

This will set version to major.minor.patch-alpha.

Release

Test bumping version

bump2version --dry-run --verbose release

Bump version

bump2version --verbose release

This will set version to major.minor.patch.

Running tests

Install dependencies

python -m pip install -r requirements-tests.txt

Plain

pytest

Inside Docker container:

with CPython

docker-compose --file docker-compose.cpython.yml up

with PyPy

docker-compose --file docker-compose.pypy.yml up

Bash script (e.g. can be used in Git hooks):

with CPython
```
./run-tests.sh
```
or
```
./run-tests.sh cpython
```
with PyPy
```
./run-tests.sh pypy
```

PowerShell script (e.g. can be used in Git hooks):

with CPython
```
.\run-tests.ps1
```
or
```
.\run-tests.ps1 cpython
```
with PyPy
```
.\run-tests.ps1 pypy
```