Use setuptools

This commit is contained in:
Joscha 2019-04-12 18:10:36 +00:00
parent 62e5adc878
commit 75abd27809
3 changed files with 30 additions and 2 deletions

5
CHANGELOG.md Normal file
View file

@ -0,0 +1,5 @@
# Changelog
## 0.1.0 (2019-04-12)
- use setuptools

View file

@ -3,9 +3,24 @@
Yaboli (**Y**et **A**nother **Bo**t **Li**brary) is a Python library for Yaboli (**Y**et **A**nother **Bo**t **Li**brary) is a Python library for
creating bots for [euphoria.io](https://euphoria.io). creating bots for [euphoria.io](https://euphoria.io).
- [Changelog](CHANGELOG.md)
Soon, markdown files containing documentation and troubleshooting info will be Soon, markdown files containing documentation and troubleshooting info will be
available. 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 ## Example echo bot
A simple echo bot that conforms to the 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 ## TODOs
- [ ] implement !restart - [ ] 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?) - [ ] document yaboli (markdown files in a "docs" folder?)
- [ ] cookie support - [ ] cookie support
- [ ] fancy argument parsing - [ ] 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] config file support for bots, used by default
- [x] make it easier to enable log messages - [x] make it easier to enable log messages
- [x] make it easier to run bots - [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`)

8
setup.py Normal file
View file

@ -0,0 +1,8 @@
from setuptools import setup
setup(
name="yaboli",
version="0.1.0",
packages=["yaboli"],
install_requires=["websockets==7.0"],
)