Metadata-Version: 2.1
Name: timewinder
Version: 0.1.dev0
Summary: Temporal logic models for Python
Home-page: https://github.com/barakmich/timewinder
Author: Barak Michener
Author-email: me@barakmich.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: dataclasses
Requires-Dist: msgpack
Requires-Dist: varname

# timewinder

[![license](https://img.shields.io/github/license/timewinder-dev/timewinder)](https://github.com/timewinder-dev/timewinder/blob/master/LICENSE)
[![tests](https://github.com/timewinder-dev/timewinder/workflows/tests/badge.svg)](https://github.com/timewinder-dev/timewinder/actions?query=workflow%3Atests)
[![version](https://img.shields.io/pypi/v/timewinder)](https://pypi.org/project/timewinder/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/timewinder)](https://pypi.org/project/timewinder/)

Temporal logic models for Python

## Installation

You can simply `pip install timewinder`.

## Developing

### Pre-requesites

You will need to install `flit` (for building the package) and `tox` (for orchestrating testing and documentation building):

```
python3 -m pip install flit tox
```

Clone the repository:

```
git clone https://github.com/barakmich/timewinder
```

### Running the test suite

You can run the full test suite with:

```
tox
```

### Building the documentation

You can build the HTML documentation with:

```
tox -e docs
```

The built documentation is available at `docs/_build/index.html.


