Skip to content

Commit

Permalink
Add tool rstfmt to auto-format ReST
Browse files Browse the repository at this point in the history
Signed-off-by: Samuel Giffard <[email protected]>
  • Loading branch information
Samuel Giffard committed Oct 12, 2023
1 parent 0bff6b4 commit 1d0c248
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 49 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ mypy:
fmt:
isort $(PYTHON_SOURCE_DIRS)
black $(PYTHON_SOURCE_DIRS)
$(PYTHON) -m rstfmt README.rst -w 100

.PHONY: coverage
coverage:
Expand Down
112 changes: 63 additions & 49 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,107 +2,121 @@

|Build badge| |PyPI badge| |Python versions badge|

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.
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.

Features
========
##########
Features
##########

- Supported object storages: Azure, GCP, S3, Swift (OpenStack), local file storage, and SFTP.
- Supported compression algorithms: `Snappy`_, `zstd`_, and `lzma`_.
- Supported object storages: Azure, GCP, S3, Swift (OpenStack), local file storage, and SFTP.
- Supported compression algorithms: Snappy_, zstd_, and lzma_.

Requirements
============
##############
Requirements
##############

Rohmu requires Python >= 3.8. For Python library dependencies, refer to `setup.cfg`_.
Rohmu requires Python >= 3.8. For Python library dependencies, refer to setup.cfg_.

Usage example
=============
###############
Usage example
###############

*Add usage example here*

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`_ 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 created by and is maintained by Aiven_.

Rohmu was originally a part of `PGHoard`_ but was later extracted to its own GitHub project.
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
=======
#########
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.
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
###########

Copyright (C) 2023 Aiven Ltd and contributors to the Rohmu project.

..
--------- Links ---------
.. _rohmu_repo: https://github.com/Aiven-Open/rohmu
--------- Links ---------
.. _PGHoard: https://github.com/Aiven-Open/pghoard
.. _@evche-aiven: https://github.com/evche-aiven

.. _MyHoard: https://github.com/Aiven-Open/myhoard
.. _aiven: https://aiven.io

.. _Astacus: https://github.com/Aiven-Open/astacus
.. _astacus: https://github.com/Aiven-Open/astacus

.. _Snappy: https://github.com/andrix/python-snappy
.. _how rohmu is used in pghoard: https://github.com/Aiven-Open/pghoard/tree/main/pghoard/basebackup

.. _zstd: https://github.com/facebook/zstd
.. _license: https://github.com/Aiven-Open/rohmu/blob/main/LICENSE

.. _lzma: https://docs.python.org/3/library/lzma.html

.. _setup.cfg: https://github.com/Aiven-Open/rohmu/blob/main/setup.cfg
.. _myhoard: https://github.com/Aiven-Open/myhoard

.. _how Rohmu is used in PGHoard: https://github.com/Aiven-Open/pghoard/tree/main/pghoard/basebackup
.. _pghoard: https://github.com/Aiven-Open/pghoard

.. _LICENSE: https://github.com/Aiven-Open/rohmu/blob/main/LICENSE
.. _rohmu_repo: https://github.com/Aiven-Open/rohmu

.. _Aiven: https://aiven.io
.. _security: https://github.com/Aiven-Open/rohmu/blob/main/SECURITY.md

.. _@evche-aiven: https://github.com/evche-aiven
.. _setup.cfg: https://github.com/Aiven-Open/rohmu/blob/main/setup.cfg

.. _security: https://github.com/Aiven-Open/rohmu/blob/main/SECURITY.md
.. _snappy: https://github.com/andrix/python-snappy

.. _zstd: https://github.com/facebook/zstd

..
--------- Badges & Images ---------
--------- Badges & Images ---------
.. |Rohmu logo| image:: https://raw.githubusercontent.com/Aiven-Open/rohmu/main/logo.png
:alt: Rohmu logo

.. |Build badge| image:: https://github.com/Aiven-Open/rohmu/actions/workflows/build.yml/badge.svg
:target: https://github.com/Aiven-Open/rohmu/actions
:alt: Build status
:target: https://github.com/Aiven-Open/rohmu/actions

.. |PyPI badge| image:: https://img.shields.io/pypi/v/rohmu.svg
:target: https://pypi.org/project/rohmu/
:alt: PyPI version
:target: https://pypi.org/project/rohmu/

.. |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
1 change: 1 addition & 0 deletions requirements.dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ pytest-cov
pytest-mock
pytest-timeout
pytest-asyncio
rstfmt
types-python-dateutil
types-paramiko
types-botocore
Expand Down

0 comments on commit 1d0c248

Please sign in to comment.