diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index 7b4fd5c..072ae70 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -1,4 +1,4 @@ -name: Python package +name: CI on: push: diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a6f970 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Python-Multipart + +[![Build Status](https://github.com/Kludex/python-multipart/workflows/CI/badge.svg)](https://github.com/Kludex/python-multipart/actions) +[![Package version](https://badge.fury.io/py/python-multipart.svg)](https://pypi.python.org/pypi/python-multipart) +[![Supported Python Version](https://img.shields.io/pypi/pyversions/python-multipart.svg?color=%2334D058)](https://pypi.org/project/python-multipart) + +--- + +`python-multipart` is an Apache2 licensed streaming multipart parser for Python. +Test coverage is currently 100%. + +## Why? + +Because streaming uploads are awesome for large files. + +## How to Test + +If you want to test: + +```bash +$ pip install '.[dev]' +$ inv test +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index 7bdc864..0000000 --- a/README.rst +++ /dev/null @@ -1,28 +0,0 @@ -================== - Python-Multipart -================== - -.. image:: https://github.com/andrew-d/python-multipart/actions/workflows/test.yaml/badge.svg - :target: https://github.com/andrew-d/python-multipart/actions - - -python-multipart is an Apache2 licensed streaming multipart parser for Python. -Test coverage is currently 100%. -Documentation is available `here`_. - -.. _here: https://andrew-d.github.io/python-multipart/ - -Why? ----- - -Because streaming uploads are awesome for large files. - -How to Test ------------ - -If you want to test: - -.. code-block:: bash - - $ pip install '.[dev]' - $ inv test diff --git a/pyproject.toml b/pyproject.toml index 5833d83..ed22c97 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,10 +6,13 @@ build-backend = "hatchling.build" name = "python-multipart" dynamic = ["version"] description = "A streaming multipart parser for Python" -readme = "README.rst" +readme = "README.md" license = "Apache-2.0" requires-python = ">=3.8" -authors = [{ name = "Andrew Dunham", email = "andrew@du.nham.ca" }] +authors = [ + { name = "Andrew Dunham", email = "andrew@du.nham.ca" }, + { name = "Marcelo Trylesinski", email = "marcelotryle@gmail.com" }, +] classifiers = [ 'Development Status :: 5 - Production/Stable', 'Environment :: Web Environment', @@ -46,10 +49,10 @@ dev = [ ] [project.urls] -Homepage = "https://github.com/andrew-d/python-multipart" +Homepage = "https://github.com/Kludex/python-multipart" Documentation = "https://andrew-d.github.io/python-multipart/" -Changelog = "https://github.com/andrew-d/python-multipart/blob/master/CHANGELOG.md" -Source = "https://github.com/andrew-d/python-multipart" +Changelog = "https://github.com/Kludex/python-multipart/blob/master/CHANGELOG.md" +Source = "https://github.com/Kludex/python-multipart" [tool.hatch.version] path = "multipart/__init__.py"