xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-zulip-api/zulip_bots/setup.py

66 lines
1.9 KiB
Python
Raw Normal View History

lint: Require python3 shebangs. This commit was originally from @fredfishgames, but it needed a big rebase due to use letting it sit too long. Also, we decided not to have shebangs at the top of test files.
2017-12-12 08:05:41 -05:00
#!/usr/bin/env python3
bots: Move all bots and the bots API to separate package.
2017-07-18 00:17:16 -04:00
Remove legacy distutils support. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-09 20:48:32 -05:00
from setuptools import find_packages, setup
bots: Move all bots and the bots API to separate package.
2017-07-18 00:17:16 -04:00
pypi: Release version 0.8.1.
2021-10-19 17:53:14 -04:00
ZULIP_BOTS_VERSION = "0.8.1"
packaging: Automate the package release process. This commit adds a script to automate the PyPA release of the zulip, zulip_bots and zulip_botserver packages. The tools/release-packages script would take care of uploading the packages to PyPA, and push commits to both repos updating the package versions. If you have commit access to the repos, you can --push upstream to master. If not, then you can --push origin to a new branch on your fork and create a PR for those changes. Ideally, a release shouldn't take longer than however long it takes one to type the above command. If you have SSH set up on GitHub, you won't need to type in your GitHub username and password. You can also store your PyPA credentials in a file in your home directory; it isn't very secure, but it saves time nevertheless.
2017-09-18 20:04:03 -04:00
IS_PYPA_PACKAGE = False
packages: Stop hardcoding version in dependency checks. In zulip_bots/setup.py, we now don't specify a minimum version when checking for dependency on the zulip package. We just want the latest one. In zulip_botserver/setup.py, we now don't specify a minimum version when checking for dependencies on the zulip and zulip_bots package. We just want the latest ones.
2017-09-20 19:02:43 -04:00
zulip_bots: Use package_data instead of MANIFEST.in. 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.
2018-01-08 16:46:10 -05:00
package_data = {
black: Reformat without skipping string normalization.
2021-05-28 05:05:11 -04:00
"": ["doc.md", "*.conf", "assets/*"],
"zulip_bots": ["py.typed"],
zulip_bots: Use package_data instead of MANIFEST.in. 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.
2018-01-08 16:46:10 -05:00
}
tools: Delete the release-packages script. This script has been outdated for a long time now and has been obsoleted by some recent changes in how packages should be built and distributed. In general, the release process is now too complicated to automate, so we are better off just making the release manually.
2022-01-04 21:29:10 -05:00
# IS_PYPA_PACKAGE should be set to True before making a PyPA release.
packaging: Automate the package release process. This commit adds a script to automate the PyPA release of the zulip, zulip_bots and zulip_botserver packages. The tools/release-packages script would take care of uploading the packages to PyPA, and push commits to both repos updating the package versions. If you have commit access to the repos, you can --push upstream to master. If not, then you can --push origin to a new branch on your fork and create a PR for those changes. Ideally, a release shouldn't take longer than however long it takes one to type the above command. If you have SSH set up on GitHub, you won't need to type in your GitHub username and password. You can also store your PyPA credentials in a file in your home directory; it isn't very secure, but it saves time nevertheless.
2017-09-18 20:04:03 -04:00
if not IS_PYPA_PACKAGE:
black: Reformat without skipping string normalization.
2021-05-28 05:05:11 -04:00
package_data[""].append("fixtures/*.json")
package_data[""].append("logo.*")
packages: Stop hardcoding version in dependency checks. In zulip_bots/setup.py, we now don't specify a minimum version when checking for dependency on the zulip package. We just want the latest one. In zulip_botserver/setup.py, we now don't specify a minimum version when checking for dependencies on the zulip and zulip_bots package. We just want the latest ones.
2017-09-20 19:02:43 -04:00
Modernize legacy Python 2 syntax with pyupgrade. Generated by `pyupgrade --py3-plus --keep-percent-format` followed by manual indentation fixes. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-09 20:14:01 -04:00
with open("README.md") as fh:
pypi_packages: Use README files for long descriptions.
2020-04-16 20:34:03 -04:00
long_description = fh.read()
Remove legacy distutils support. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-09 20:48:32 -05:00
setup(
black: Reformat without skipping string normalization.
2021-05-28 05:05:11 -04:00
name="zulip_bots",
packages: Stop hardcoding version in dependency checks. In zulip_bots/setup.py, we now don't specify a minimum version when checking for dependency on the zulip package. We just want the latest one. In zulip_botserver/setup.py, we now don't specify a minimum version when checking for dependencies on the zulip and zulip_bots package. We just want the latest ones.
2017-09-20 19:02:43 -04:00
version=ZULIP_BOTS_VERSION,
black: Reformat without skipping string normalization.
2021-05-28 05:05:11 -04:00
description="Zulip's Bot framework",
pypi_packages: Use README files for long descriptions.
2020-04-16 20:34:03 -04:00
long_description=long_description,
long_description_content_type="text/markdown",
black: Reformat without skipping string normalization.
2021-05-28 05:05:11 -04:00
author="Zulip Open Source Project",
author_email="zulip-devel@googlegroups.com",
bots: Move all bots and the bots API to separate package.
2017-07-18 00:17:16 -04:00
classifiers=[
black: Reformat without skipping string normalization.
2021-05-28 05:05:11 -04:00
"Development Status :: 4 - Beta",
"Environment :: Web Environment",
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
"Topic :: Communications :: Chat",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
bots: Move all bots and the bots API to separate package.
2017-07-18 00:17:16 -04:00
],
black: Reformat without skipping string normalization.
2021-05-28 05:05:11 -04:00
python_requires=">=3.6",
url="https://www.zulip.org/",
setup.py: Add Source & Documentation project_urls. The only existing url points to zulip.org -> zulipchat.com
2020-05-02 18:31:39 -04:00
project_urls={
"Source": "https://github.com/zulip/python-zulip-api/",
Update zulipchat.com links to zulip.com. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-08 17:03:27 -04:00
"Documentation": "https://zulip.com/api",
setup.py: Add Source & Documentation project_urls. The only existing url points to zulip.org -> zulipchat.com
2020-05-02 18:31:39 -04:00
},
bots: Move all bots and the bots API to separate package.
2017-07-18 00:17:16 -04:00
entry_points={
black: Reformat without skipping string normalization.
2021-05-28 05:05:11 -04:00
"console_scripts": [
"zulip-run-bot=zulip_bots.run:main",
bots: Migrate source file for zulip-bot-shell to similar name.
2021-11-20 02:00:56 -05:00
"zulip-bot-shell=zulip_bots.bot_shell:main",
bots: Move all bots and the bots API to separate package.
2017-07-18 00:17:16 -04:00
],
},
install_requires=[
black: Reformat without skipping string normalization.
2021-05-28 05:05:11 -04:00
"pip",
"zulip",
"html2text",
"lxml",
"BeautifulSoup4",
"typing_extensions",
bots: Find external packaged bots via 'zulip_bots.registry' entry_point. Now we will be able to execute `zulip-run-bot` with the `-r` argument to search for and run bots from the `zulip_bots.registry` entry_point. Each entry point should have the name correspond to the bot name, and have the value be the bot module. E.g, an Python package for a bot called "packaged_bot" should have an `entry_points` setup like the following: setup( ... entry_points={ "zulip_bot.registry":[ "packaged_bot=packaged_bot.packaged_bot" ] } ... ) whose file structure may look like this: packaged_bot/ ├───packaged_bot/ | ├───packaged_bot.py # The bot module | ├───test_packaged_bot.py | ├───packaged_bot.conf | └───doc.md └───setup.py # Register the entry points here Add test case.
2021-07-22 00:13:40 -04:00
'importlib-metadata >= 3.6; python_version < "3.10"',
bots: Move all bots and the bots API to separate package.
2017-07-18 00:17:16 -04:00
],
Remove legacy distutils support. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-09 20:48:32 -05:00
packages=find_packages(),
package_data=package_data,
bots: Move all bots and the bots API to separate package.
2017-07-18 00:17:16 -04:00
)
Reference in a new issue Copy permalink