Metadata-Version: 2.1
Name: basic-iter
Version: 0.0.4
Summary: A basic set of functions on iterators
License: MIT
Author: Takayuki Goto
Author-email: nephits@gmail.com
Maintainer: Takayuki Goto
Maintainer-email: nephits@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Description-Content-Type: text/markdown

# Basic Iterator Operators for Python

This package provides basic functions on sequences (now only `list` is supported).
All these provided functions are defined in functional way and do not update given arguments, but return newly constructed values.


## Install

```sh
$ pip install basic_iter
```

## Develop

## Install dependencies for developing

```sh
basic_iter$ poetry install --no-root
```


### Generate documents

To generate documents:

```sh
basic_iter$ make doc
```

This will generate documentation under `./docs/build/html`.


## Format Checking

For format checking by black:

```sh
basic_iter$ make format_check
```


## Type Checking

For type checking by mypy:

```sh
basic_iter$ make type_check
```


## Unit Test

For executing unit tests:

```sh
basic_iter$ make test
```



