Merge pull request #151 from Aiven-Open/sgiffard/fix-readme

Fix the README.rst

Makefile

@@ -37,6 +37,7 @@ mypy:
 fmt:
 	isort $(PYTHON_SOURCE_DIRS)
 	black $(PYTHON_SOURCE_DIRS)
+	$(PYTHON) -m rstfmt README.rst -w 100
 
 .PHONY: coverage
 coverage:

README.rst

@@ -1,83 +1,122 @@
-.. image:: logo.png
+|Rohmu logo|
 
-Rohmu is a Python library for building backup tools for databases
-providing functionality for compression, encryption and transferring
-data between the database and an object storage. Rohmu supports main
-public clouds such as GCP, AWS and Azure for backup storage. Rohmu is
-used in various backup tools such as
-`PGHoard <https://github.com/aiven/pghoard>`__ for PostgreSQL,
-`MyHoard <https://github.com/aiven/myhoard>`__ for MySQL and
-`Astacus <https://github.com/aiven/astacus>`__ for M3 and ClickHouse and
-other databases.
+|Build badge| |PyPI badge| |Python versions badge|
 
-Features
-========
+Rohmu is a Python library for building backup tools for databases providing functionality for
+compression, encryption, and transferring data between the database and an object storage. Rohmu
+supports main public clouds such as GCP, AWS, and Azure for backup storage. Rohmu is used in various
+backup tools such as PGHoard_ for PostgreSQL, MyHoard_ for MySQL, and Astacus_ for M3, ClickHouse,
+and other databases.
 
--  Supported object storages: Azure, GCP, S3, Swift (OpenStack), local
-   file storage and SFTP.
--  Supported compression algorithms: Snappy,
-   `zstd <https://github.com/facebook/zstd>`__ and
-   `lzma <https://docs.python.org/3/library/lzma.html>`__.
+##########
+ Features
+##########
 
-Requirements
-============
+-  Supported object storages: Azure, GCP, S3, Swift (OpenStack), local file storage, and SFTP.
+-  Supported compression algorithms: Snappy_, zstd_, and lzma_.
 
-Rohmu requires Python >= 3.8. For Python library dependencies, have a
-look at
-`requirements.txt <https://github.com/aiven/rohmu/blob/main/requirements.txt>`__.
+##############
+ Requirements
+##############
 
-Usage example
-=============
+Rohmu requires Python >= 3.8. For Python library dependencies, refer to setup.cfg_.
+
+###############
+ Usage example
+###############
 
 *Add usage example here*
 
-For real-world usage you can have a look at `how Rohmu is used in
-PGHoard <https://github.com/aiven/pghoard/blob/main/pghoard/basebackup.py>`__.
+For real-world usage, see `how Rohmu is used in PGHoard`_.
 
-Development
-===========
+#############
+ Development
+#############
 
 *TODO*
 
-License
-=======
+#########
+ License
+#########
 
-Rohmu is licensed under the Apache license, version 2.0. Full license
-text is available in the `LICENSE <LICENSE>`__ file.
+Rohmu is licensed under the Apache license, version 2.0. Full license text is available in the
+LICENSE_ file.
 
-Please note that the project explicitly does not require a CLA
-(Contributor License Agreement) from its contributors.
+Please note that the project explicitly does not require a CLA (Contributor License Agreement) from
+its contributors.
 
-Trademarks
-==========
+############
+ Trademarks
+############
 
-PostgreSQL, MySQL, M3 and ClickHouse are trademarks and property of
-their respective owners. All product and service names used in this
-website are for identification purposes only and do not imply
+PostgreSQL, MySQL, M3 and ClickHouse are trademarks and property of their respective owners. All
+product and service names used in this website are for identification purposes only and do not imply
 endorsement.
 
-Credits
-=======
+#########
+ Credits
+#########
+
+Rohmu was created by and is maintained by Aiven_.
+
+Rohmu was originally a part of PGHoard_ but was later extracted to its own GitHub project.
+
+The Rohmu logo was created by `@evche-aiven`_.
+
+#########
+ Contact
+#########
+
+Bug reports and patches are very welcome; please post them as GitHub issues and pull requests at
+rohmu_repo_. To report any possible vulnerabilities or other serious issues, please see our
+security_ policy.
+
+###########
+ Copyright
+###########
+
+Copyright (C) 2023 Aiven Ltd and contributors to the Rohmu project.
+
+..
+   --------- Links ---------
+
+.. _@evche-aiven: https://github.com/evche-aiven
+
+.. _aiven: https://aiven.io
+
+.. _astacus: https://github.com/Aiven-Open/astacus
+
+.. _how rohmu is used in pghoard: https://github.com/Aiven-Open/pghoard/tree/main/pghoard/basebackup
+
+.. _license: https://github.com/Aiven-Open/rohmu/blob/main/LICENSE
+
+.. _lzma: https://docs.python.org/3/library/lzma.html
+
+.. _myhoard: https://github.com/Aiven-Open/myhoard
+
+.. _pghoard: https://github.com/Aiven-Open/pghoard
+
+.. _rohmu_repo: https://github.com/Aiven-Open/rohmu
+
+.. _security: https://github.com/Aiven-Open/rohmu/blob/main/SECURITY.md
+
+.. _setup.cfg: https://github.com/Aiven-Open/rohmu/blob/main/setup.cfg
 
-Rohmu was created by and is maintained by `Aiven
-<https://aiven.io>`__.
+.. _snappy: https://github.com/andrix/python-snappy
 
-Rohmu was originally a part of `PGHoard
-<https://github.com/aiven/pghoard>`__ but was later extracted to its
-own GitHub project.
+.. _zstd: https://github.com/facebook/zstd
 
-The Rohmu logo was created by `@evche-aiven
-<https://github.com/evche-aiven>`__.
+..
+   --------- Badges & Images ---------
 
-Contact
-=======
+.. |Rohmu logo| image:: https://raw.githubusercontent.com/Aiven-Open/rohmu/main/logo.png
 
-Bug reports and patches are very welcome, please post them as GitHub
-issues and pull requests at https://github.com/aiven/rohmu . To report
-any possible vulnerabilities or other serious issues please see our
-`security <SECURITY.md>`__ policy.
+.. |Build badge| image:: https://github.com/Aiven-Open/rohmu/actions/workflows/build.yml/badge.svg
+   :alt: Build status
+   :target: https://github.com/Aiven-Open/rohmu/actions
 
-Copyright
-=========
+.. |PyPI badge| image:: https://img.shields.io/pypi/v/rohmu.svg
+   :alt: PyPI version
+   :target: https://pypi.org/project/rohmu/
 
-Copyright (C) 2022 Aiven Ltd and contributors to the Rohmu project.
+.. |Python versions badge| image:: https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue

requirements.dev.txt

@@ -13,6 +13,7 @@ pytest-cov
 pytest-mock
 pytest-timeout
 pytest-asyncio
+rstfmt
 types-python-dateutil
 types-paramiko
 types-botocore