Metadata-Version: 2.1
Name: topo
Version: 0.0.1
Summary: Topology models.
Home-page: https://github.com/lycantropos/topo/
Author: Azat Ibrakov
Author-email: azatibrakov@gmail.com
License: UNKNOWN
Download-URL: https://github.com/lycantropos/topo/archive/master.zip
Description: topo
        ====
        
        [![](https://travis-ci.org/lycantropos/topo.svg?branch=master)](https://travis-ci.org/lycantropos/topo "Travis CI")
        [![](https://ci.appveyor.com/api/projects/status/github/lycantropos/topo?branch=master&svg=true)](https://ci.appveyor.com/project/lycantropos/topo "AppVeyor")
        [![](https://codecov.io/gh/lycantropos/topo/branch/master/graph/badge.svg)](https://codecov.io/gh/lycantropos/topo "Codecov")
        [![](https://img.shields.io/github/license/lycantropos/topo.svg)](https://github.com/lycantropos/topo/blob/master/LICENSE "License")
        [![](https://badge.fury.io/py/topo.svg)](https://badge.fury.io/py/topo "PyPI")
        
        In what follows
        - `python` is an alias for `python3.5` or any later
        version (`python3.6` and so on),
        - `pypy` is an alias for `pypy3.5` or any later
        version (`pypy3.6` and so on).
        
        Installation
        ------------
        
        Install the latest `pip` & `setuptools` packages versions:
        - with `CPython`
          ```bash
          python -m pip install --upgrade pip setuptools
          ```
        - with `PyPy`
          ```bash
          pypy -m pip install --upgrade pip setuptools
          ```
        
        ### User
        
        Download and install the latest stable version from `PyPI` repository:
        - with `CPython`
          ```bash
          python -m pip install --upgrade topo
          ```
        - with `PyPy`
          ```bash
          pypy -m pip install --upgrade topo
          ```
        
        ### Developer
        
        Download the latest version from `GitHub` repository
        ```bash
        git clone https://github.com/lycantropos/topo.git
        cd topo
        ```
        
        Install:
        - with `CPython`
          ```bash
          python setup.py install
          ```
        - with `PyPy`
          ```bash
          pypy setup.py install
          ```
        
        Usage
        -----
        
        `topo` provides
        
        - hashable,
        - partially ordered by `<=` ("is subset of") and `>=` ("is superset of") relations,
        - strictly ordered by `<` ("is strict subset of") and `>` ("is strict superset of") relations
        
        models & objects:
        
        - `EMPTY_SET`: for set with no elements
            ```python
            >>> from topo.base import EMPTY_SET
            >>> EMPTY_SET
            EmptySet()
            >>> str(EMPTY_SET)
            '{}'
            >>> EMPTY_SET <= EMPTY_SET
            True
            >>> EMPTY_SET < EMPTY_SET
            False
            >>> 1 in EMPTY_SET
            False
            # and so on for every object
            ```
        - `DiscreteSet`: for discrete sets of hashable objects 
        (similar to built-in `set`s)
            ```python
            >>> from topo.discrete import DiscreteSet
            >>> binary_set = DiscreteSet(0, 1)
            >>> binary_set
            DiscreteSet(0, 1)
            >>> str(binary_set)
            '{0, 1}'
            >>> EMPTY_SET <= binary_set
            True
            >>> binary_set < EMPTY_SET
            False
            >>> 0 in binary_set
            True
            >>> 10 in binary_set
            False
            ```
        - `Interval`: for intervals of floating point numbers
            ```python
            >>> from topo.continuous import Interval
            >>> unit_segment = Interval(0, 1)
            >>> unit_segment
            Interval(0, 1, left_end_inclusive=True, right_end_inclusive=True)
            >>> str(unit_segment)
            '[0, 1]'
            >>> binary_set <= unit_segment
            True
            >>> unit_segment < binary_set
            False
            >>> 0.5 in unit_segment
            True
            >>> 10 in unit_segment
            False
            ```
        
        with next operators overloaded:
        
        - `|`: for sets union
            ```python
            >>> unit_segment | binary_set
            Interval(0, 1, left_end_inclusive=True, right_end_inclusive=True)
            ```
            since `unit_segment` contains `binary_set` elements.
        
        - `-`: for sets difference
            ```python
            >>> unit_segment - binary_set
            Interval(0, 1, left_end_inclusive=False, right_end_inclusive=False)
            ```
            as we can see both ends were excluded.
        
        - `&`: for sets intersection
            ```python
            >>> unit_segment & binary_set
            DiscreteSet(0, 1)
            ```
        
        Also used in conditionals sets will evaluate to `False` 
        if they are considered empty and `True` otherwise:
        
        ```python
        >>> if not EMPTY_SET:
                print('Hello World!')
            else:
                print('Something went wrong.')
        Hello World!
        ```
                    
        
        Development
        -----------
        
        ### Bumping version
        
        #### Preparation
        
        Install
        [bump2version](https://github.com/c4urself/bump2version#installation).
        
        #### Pre-release
        
        Choose which version number category to bump following [semver
        specification](http://semver.org/).
        
        Test bumping version
        ```bash
        bump2version --dry-run --verbose $CATEGORY
        ```
        
        where `$CATEGORY` is the target version number category name, possible
        values are `patch`/`minor`/`major`.
        
        Bump version
        ```bash
        bump2version --verbose $CATEGORY
        ```
        
        This will set version to `major.minor.patch-alpha`. 
        
        #### Release
        
        Test bumping version
        ```bash
        bump2version --dry-run --verbose --tag release
        ```
        
        Bump version
        ```bash
        bump2version --verbose --tag release
        ```
        
        This will set version to `major.minor.patch` and add `Git` tag.
        
        #### Notes
        
        To avoid inconsistency between branches and pull requests,
        bumping version should be merged into `master` branch as separate pull
        request.
        
        ### Running tests
        
        Plain:
        - with `CPython`
          ```bash
          python setup.py test
          ```
        - with `PyPy`
          ```bash
          pypy setup.py test
          ```
        
        Inside `Docker` container:
        - with `CPython`
          ```bash
          docker-compose --file docker-compose.cpython.yml up
          ```
        - with `PyPy`
          ```bash
          docker-compose --file docker-compose.pypy.yml up
          ```
        
        `Bash` script (e.g. can be used in `Git` hooks):
        - with `CPython`
          ```bash
          ./run-tests.sh
          ```
          or
          ```bash
          ./run-tests.sh cpython
          ```
        
        - with `PyPy`
          ```bash
          ./run-tests.sh pypy
          ```
        
        `PowerShell` script (e.g. can be used in `Git` hooks):
        - with `CPython`
          ```powershell
          .\run-tests.ps1
          ```
          or
          ```powershell
          .\run-tests.ps1 cpython
          ```
        - with `PyPy`
          ```powershell
          .\run-tests.ps1 pypy
          ```
        
Platform: UNKNOWN
Requires-Python: >=3.5
Description-Content-Type: text/markdown
