Move to pyproject.toml and cleanup non-source files

.github/workflows/CI.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v3

CHANGELOG.md

@@ -1,3 +1,11 @@
+### 1.0.3 / 2023-12-12
+
+- Move to `pyproject.toml` to support dependabot [#56](https://github.com/tus/tus-py-client/issues/56)
+- Remove `AUTHORS`
+- Autogenerate `CONTRIBUTORS` from git history
+- Update licence to refer to `CONTRIBUTORS`
+- Add extra badges to `README.md`
+
 ### 1.0.2 / 2023-11-30
 
 - Remove unnecessary future install requirement [#81](https://github.com/tus/tus-py-client/pulls/81)

CONTRIBUTORS

@@ -1,3 +1,27 @@
-Contributors:
-# Names should be added to this file as:
-#     Name <email address>
+The following people have contributed to tus-py-client:
+
+Ifedapo Olarewaju ([email protected])
+Marius ([email protected])
+Mariusz Obajtek ([email protected])
+Nykakin ([email protected])
+Omer Katz ([email protected])
+Kirill Malovitsa ([email protected])
+Peixian Wang ([email protected])
+VImeo-Loaner ([email protected])
+Richo Healey ([email protected])
+Brian Gardiner ([email protected])
+David D Lowe ([email protected])
+mochic808 ([email protected])
+mohsenjavidpanah ([email protected])
+Adrian Partl ([email protected])
+ifedapoolarewaju ([email protected])
+Brian Tate ([email protected])
+Dave Takahashi ([email protected])
+Guang-De Lin ([email protected])
+Janne Pulkkinen ([email protected])
+Honglei ([email protected])
+Hemant Sachdeva ([email protected])
+Jasper ([email protected])
+Marius Kleidl ([email protected])
+Nicola Soranzo ([email protected])
+Nicholas Hairs ([email protected])

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 Ifedapo .A. Olarewaju
+Copyright (c) The tus-py-client CONTRIBUTORS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -1 +1,2 @@
 include README.md
+include CONTRIBUTORS

README.md

@@ -1,4 +1,10 @@
-# tus-py-client [![Build Status](https://github.com/tus/tus-py-client/actions/workflows/CI.yml/badge.svg)](https://github.com/tus/tus-py-client/actions/workflows/CI.yml)
+# tus-py-client
+[![PyPi](https://img.shields.io/pypi/v/tuspy.svg)](https://pypi.python.org/pypi/tuspy/)
+[![PyPI - Status](https://img.shields.io/pypi/status/tuspy)](https://pypi.python.org/pypi/tuspy/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/tuspy.svg)](https://github.com/tus/tus-py-client)
+[![License](https://img.shields.io/github/license/tus/tus-py-client.svg)](https://github.com/tus/tus-py-client)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/tuspy)
+[![Build Status](https://github.com/tus/tus-py-client/actions/workflows/CI.yml/badge.svg)](https://github.com/tus/tus-py-client/actions/workflows/CI.yml)
 
 > **tus** is a protocol based on HTTP for _resumable file uploads_. Resumable
 > means that an upload can be interrupted at any moment and can be resumed without
@@ -107,4 +113,4 @@ If you want to work on tus-py-client internally, follow these few steps:
 
 ## License
 
-MIT
+This project is licenced under the MIT Licence - see [`LICENCE`](https://github.com/tus/tus-py-client/blob/main/LICENSE).

pyproject.toml

@@ -0,0 +1,78 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tuspy"
+description = "A Python client for the tus resumable upload protocol ->  http://tus.io"
+authors = [
+    {name = "Ifedapo Olarewaju", email="[email protected]"},
+]
+
+# Dependency Information
+requires-python = ">=3.8"
+dependencies = [
+    "requests>=2.18.4",
+    "six>=1.11.0",
+    "tinydb>=3.5.0",
+    "aiohttp>=3.6.2",
+]
+
+# Extra Information
+readme = "README.md"
+license = {text = "MIT Licence"}
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Communications :: File Sharing",
+    "Topic :: Internet :: File Transfer Protocol (FTP)",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+
+# Misc
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "http://tus-py-client.readthedocs.io/en/latest/"
+GitHub = "http://github.com/tus/tus-py-client/"
+
+[project.optional-dependencies]
+test = [
+    "responses>=0.5.1",
+    "aioresponses>=0.6.2",
+    "coverage>=4.2",
+    "pytest>=3.0.3",
+    "pytest-cov>=2.3.1,<2.6",
+]
+
+dev = [
+    "tox>=2.3.1",
+    "sphinx-autobuild==2021.3.14",
+    "Sphinx==1.7.1",
+]
+
+[tool.setuptools]
+packages = [
+    "tusclient",
+    "tusclient.fingerprint",
+    "tusclient.storage",
+    "tusclient.uploader",
+]
+include-package-data = true
+platforms = ["any"]
+
+[tool.setuptools.dynamic]
+version = {attr = "tusclient.__version__"}
+

tests/test_uploader.py

@@ -94,19 +94,19 @@ def test_get_file_stream(self):
             self.uploader.file_path = None
             self.assertEqual(self.uploader.file_stream, self.uploader.get_file_stream())
 
-        with open('./AUTHORS', 'rb') as fs:
+        with open('./README.md', 'rb') as fs:
             self.uploader.file_stream = None
-            self.uploader.file_path = './AUTHORS'
+            self.uploader.file_path = './README.md'
             with self.uploader.get_file_stream() as stream:
                 self.assertEqual(fs.read(), stream.read())
 
     def test_file_size(self):
         self.assertEqual(self.uploader.get_file_size(), os.path.getsize(self.uploader.file_path))
 
-        with open('./AUTHORS', 'rb') as fs:
+        with open('./README.md', 'rb') as fs:
             self.uploader.file_stream = fs
             self.uploader.file_path = None
-            self.assertEqual(self.uploader.get_file_size(), os.path.getsize('./AUTHORS'))
+            self.assertEqual(self.uploader.get_file_size(), os.path.getsize('./README.md'))
 
     @mock.patch('tusclient.uploader.uploader.TusRequest')
     def test_upload_chunk(self, request_mock):

tusclient/__init__.py

@@ -1 +1 @@
-__version__ = '1.0.2'
+__version__ = '1.0.3'