Metadata-Version: 2.1
Name: unminder
Version: 0.1.0
Summary: Queue things in a list, review them later.
Home-page: https://github.com/pawamoy/unminder
License: ISC
Author: Timothée Mazzucotelli
Author-email: pawamoy@pm.me
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: telethon (>=1.14.0,<2.0.0)
Project-URL: Repository, https://github.com/pawamoy/unminder
Description-Content-Type: text/markdown

# Unminder

[![ci](https://github.com/pawamoy/unminder/workflows/ci/badge.svg)](https://github.com/pawamoy/unminder/actions?query=workflow%3Aci)
[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://pawamoy.github.io/unminder/)
[![pypi version](https://img.shields.io/pypi/v/unminder.svg)](https://pypi.org/project/unminder/)

Queue things in a list, review them later.

## Requirements

Unminder requires Python 3.6 or above.

<details>
<summary>To install Python 3.6, I recommend using <a href="https://github.com/pyenv/pyenv"><code>pyenv</code></a>.</summary>

```bash
# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv

# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"

# install Python 3.6
pyenv install 3.6.8

# make it available globally
pyenv global system 3.6.8
```
</details>

## Installation

With `pip`:
```bash
python3.6 -m pip install unminder
```

With [`pipx`](https://github.com/pipxproject/pipx):
```bash
python3.6 -m pip install --user pipx

pipx install --python python3.6 unminder
```

