diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..441303b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## 0.1.0 (2019-04-12) + +- use setuptools diff --git a/README.md b/README.md index 70ad6a7..27b0d91 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,24 @@ Yaboli (**Y**et **A**nother **Bo**t **Li**brary) is a Python library for creating bots for [euphoria.io](https://euphoria.io). +- [Changelog](CHANGELOG.md) + Soon, markdown files containing documentation and troubleshooting info will be available. +## Installation + +Ensure that you have at least Python 3.7 installed. The commands below assume +that `python` points this version of Python. + +In your project directory, run: + +``` +$ python -m venv . +$ . bin/activate +$ pip install git+https://github.com/Garmelon/yaboli +``` + ## Example echo bot A simple echo bot that conforms to the @@ -44,8 +59,6 @@ i. e. the text between the end of the "!echo" and the end of the whole message. ## TODOs - [ ] implement !restart -- [ ] package in a distutils-compatible way (users should be able to install - yaboli using `pip install git+https://github.com/Garmelon/yaboli`) - [ ] document yaboli (markdown files in a "docs" folder?) - [ ] cookie support - [ ] fancy argument parsing @@ -58,3 +71,5 @@ i. e. the text between the end of the "!echo" and the end of the whole message. - [x] config file support for bots, used by default - [x] make it easier to enable log messages - [x] make it easier to run bots +- [x] package in a distutils-compatible way (users should be able to install + yaboli using `pip install git+https://github.com/Garmelon/yaboli`) diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..5e26be5 --- /dev/null +++ b/setup.py @@ -0,0 +1,8 @@ +from setuptools import setup + +setup( + name="yaboli", + version="0.1.0", + packages=["yaboli"], + install_requires=["websockets==7.0"], +)