From b3b90fb23b88293468c81e7a11f618e2a28a602a Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Sat, 6 Mar 2021 12:07:04 +0100 Subject: [PATCH] Improve documentation --- CHANGES.rst | 1 + README.rst | 30 ++++++++++++++++++++++-------- setup.py | 6 ++++++ 3 files changed, 29 insertions(+), 8 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 5010db2..b82b283 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -10,6 +10,7 @@ in progress - Store the image format for later reuse directly after reading the original image - Run black and isort on the code base - Improve dependencies +- Improve documentation 2020-06-08 0.3.0 diff --git a/README.rst b/README.rst index 06dd68a..e1f45e8 100644 --- a/README.rst +++ b/README.rst @@ -1,11 +1,20 @@ -.. image:: https://img.shields.io/badge/Python-3-green.svg - :target: https://github.com/panodata/imagecast +.. image:: https://github.com/panodata/imagecast/workflows/Tests/badge.svg + :target: https://github.com/panodata/imagecast/actions?workflow=Tests + +.. image:: https://img.shields.io/pypi/pyversions/imagecast.svg + :target: https://python.org .. image:: https://img.shields.io/pypi/v/imagecast.svg :target: https://pypi.org/project/imagecast/ -.. image:: https://img.shields.io/github/tag/panodata/imagecast.svg - :target: https://github.com/panodata/imagecast +.. image:: https://img.shields.io/pypi/status/imagecast.svg + :target: https://pypi.org/project/imagecast/ + +.. image:: https://img.shields.io/pypi/l/imagecast.svg + :target: https://pypi.org/project/imagecast/ + +.. image:: https://img.shields.io/pypi/dm/imagecast.svg + :target: https://pypi.org/project/imagecast/ | @@ -19,11 +28,12 @@ Imagecast ***** About ***** -Imagecast is like ImageMagick but for Pythonistas. -Optionally provides its features via HTTP API. -Currently, this is based on Pillow_. However, it -might be based on Wand_ in the future. +Imagecast is like ImageMagick but for Pythonistas. Optionally provides its +features via HTTP API. + +Currently, this is based on Pillow_. However, it might be based on Wand_ in +the future. There might still be dragons. @@ -49,6 +59,7 @@ With service API:: ******** Features ******** + - Colorspace conversion: monochrome, grayscale - Cropping with negative right/bottom offsets - Resizing while keeping aspect ratio @@ -59,6 +70,7 @@ Features ******** Synopsis ******** + :: # Display on screen @@ -78,6 +90,7 @@ Example:: HTTP API ======== + Start the Imagecast service as daemon:: imagecast service @@ -99,6 +112,7 @@ Example:: ************** Other projects ************** + - https://github.com/DictGet/ecce-homo - https://github.com/agschwender/pilbox - https://github.com/francescortiz/image diff --git a/setup.py b/setup.py index 3fc9664..df5b15e 100644 --- a/setup.py +++ b/setup.py @@ -12,6 +12,12 @@ license="AGPL 3, EUPL 1.2", classifiers=[ "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: Implementation :: CPython", "License :: OSI Approved :: GNU Affero General Public License v3", "License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)", "Development Status :: 3 - Alpha",