diff --git a/README.md b/README.md index 3c5910c..f837037 100644 --- a/README.md +++ b/README.md @@ -76,3 +76,17 @@ Updated 0 as deleted > s3_media_upload upload /path/to/media/store matrix_s3_bucket_name --storage-class STANDARD_IA --delete # prepare to wait a long time ``` + +Packaging +--------- + +For maintainers: + +1. Update the `__version__` in setup.py. +2. Build, check and upload to PyPI as follows: + +```shell +python -m build +twine check dist/* +twine upload dist/* +``` diff --git a/setup.py b/setup.py index 654544b..53073a4 100644 --- a/setup.py +++ b/setup.py @@ -1,12 +1,23 @@ from setuptools import setup -__version__ = "1.0" +__version__ = "1.1" + +with open("README.md") as f: + long_description = f.read() setup( name="synapse-s3-storage-provider", version=__version__, zip_safe=False, + author="matrix.org team and contributors", + description="A storage provider which can fetch and store media in Amazon S3.", + long_description=long_description, + long_description_content_type="text/markdown", url="https://github.com/matrix-org/synapse-s3-storage-provider", + classifiers=[ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: Apache Software License", + ], py_modules=["s3_storage_provider"], scripts=["scripts/s3_media_upload"], install_requires=[