Skip to content

Commit

Permalink
Migrate README from Markdown to reStructuredText
Browse files Browse the repository at this point in the history
Pypi having hard time rendering unflavoured Markdown, so an easiest
way to fix this would be to migrate to reStructuredText

Signed-off-by: Aleksei Atavin <[email protected]>
  • Loading branch information
axeoman committed May 2, 2022
1 parent 42c6ee2 commit 605b091
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 71 deletions.
69 changes: 0 additions & 69 deletions README.md

This file was deleted.

83 changes: 83 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
.. image:: logo.png

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

Features
========

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

Requirements
============

Rohmu requires Python >= 3.6+. For Python libary dependencies, have a
look at
`requirements.txt <https://github.com/aiven/rohmu/blob/main/requirements.txt>`__.

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

Development
===========

*TODO*

License
=======

Rohmu is licensed under the Apache license, version 2.0. Full license
text is available in the `LICENSE <LICENSE>`__ file.

Please note that the project explicitly does not require a CLA
(Contributor License Agreement) from its contributors.

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

Credits
=======

Rohmu was created by and is maintained by `Aiven
<https://aiven.io>`__.

Rohmu was originally a part of `PGHoard
<https://github.com/aiven/pghoard>`__ but was later extracted to its
own GitHub project.

The Rohmu logo was created by `@evche-aiven
<https://github.com/evche-aiven>`__.

Contact
=======

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.

Copyright
=========

Copyright (C) 2022 Aiven Ltd and contributors to the Rohmu project.
2 changes: 1 addition & 1 deletion rohmu.spec
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ python3 setup.py install --prefix=%{_prefix} --root=%{buildroot}

%files
%defattr(-,root,root,-)
%doc README.md
%doc README.rst
%license LICENSE
%{python3_sitelib}/*

Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = rohmu
version = attr: rohmu.version.VERSION
description = "Rohmu is a python library providing an interface to various cloud storage providers."
long_description = file: README.md
long_description = file: README.rst
license = Apache 2.0
classifiers =
Development Status :: 5 - Production/Stable
Expand Down

0 comments on commit 605b091

Please sign in to comment.