e20b754498
This commit removes generate_manifest.py and package data files are now included using the package_data kwarg to setup(). This is because, in certain situations, MANIFEST.in is a bit finicky. For instance installing a package using: python setup.py install doesn't include files specified in MANIFEST.in, while using pip install ./zulip_bots does. package_data doesn't pose this problem, ergo it's better for us.
26 lines
985 B
Markdown
26 lines
985 B
Markdown
# Zulip bots
|
|
|
|
This directory contains the source code for the `zulip_bots` PyPI package.
|
|
|
|
The Zulip documentation has guides on [using Zulip's bot system](
|
|
https://chat.zulip.org/api/running-bots)
|
|
and [writing your own bots](
|
|
https://chat.zulip.org/api/writing-bots).
|
|
|
|
## Directory structure
|
|
|
|
```shell
|
|
zulip_bots # This directory
|
|
├───zulip_bots # `zulip_bots` package.
|
|
│ ├───bots/ # Actively maintained and tested bots.
|
|
│ ├───bots_unmaintained/ # Unmaintained, potentially broken bots.
|
|
│ ├───lib.py # Backbone of run.py
|
|
│ ├───provision.py # Creates a development environment.
|
|
│ ├───run.py # Used to run bots.
|
|
│ ├───simple_lib.py # Used for terminal testing.
|
|
│ ├───test_lib.py # Backbone for bot unit tests.
|
|
│ ├───test_run.py # Unit tests for run.py
|
|
│ └───terminal.py # Used to test bots in the command line.
|
|
└───setup.py # Script for packaging.
|
|
```
|