refactor(docs): move from reST to Markdown (#145)

Converts docs from reStructuredText to Markdown so that the changelog
file is compatible with Release Please.

Author: tiborsimko

AUTHORS.md

@@ -0,0 +1,12 @@
+# Authors
+
+The list of contributors in alphabetical order:
+
+- [Adam Novorolnik](https://github.com/ANovorolnik)
+- [Alex Mieth](https://github.com/AlexMieth)
+- [Daniel Prelipcean](https://orcid.org/0000-0002-4855-194X)
+- [Jan Okraska](https://orcid.org/0000-0002-1416-3244)
+- [Jiri Kuncar](https://github.com/jirikuncar)
+- [Joud Masoud](https://github.com/joudmas)
+- [Parth Shandilya](https://github.com/ParthS007)
+- [Tibor Simko](https://orcid.org/0000-0001-7202-5803)

AUTHORS.rst

@@ -1 +1,48 @@
 # Changelog
+
+## 0.4.0 (2024-08-22)
+
+- Adds support for Python 3.11 and 3.12.
+- Improves ``get-metadata --output-field`` command by adding a new ``--filter`` option allowing to output only selected field values matching desired criteria.
+- Changes container image base to Fedora 38 and slightly optimises image size.
+- Drops support for Python 2.7.
+
+## 0.3.0 (2022-03-16)
+
+- Adds support for Python 3.10.
+- Improves ``download-files`` command to resume interrupted downloads when
+  using HTTP downloads with ``pycurl`` engine.
+- Improves XRootD downloader by using vanilla XRootD package. Changes
+  ``xrootdpyfs`` to ``xrootd`` download engine.
+- Improves ``download-files`` command with a new option ``--download-engine``
+  to select ``pycurl`` or ``requests`` engines when downloading files over
+  HTTP.
+- Fixes minor issues with file index unwinding and output directory handling.
+
+## 0.2.0 (2020-11-19)
+
+- Adds new ``list-directory`` command to list content of EOS directories
+  holding open data files.
+- Adds support for Python 3.9.
+- Improves ``download-files`` command to allow using XRootD protocol.
+- Improves ``download-files`` command to allow using HTTPS protocol.
+- Improves ``download-files`` command to optionally verify file integrity as
+  soon as files are being downloaded.
+- Improves ``get-file-locations`` command to optionally output file sizes and
+  checksums.
+- Improves output format colouring to better indicate notes and errors.
+- Fixes minor issues and improves code coverage.
+
+## 0.1.0 (2020-09-24)
+
+- Enriches ``download-files`` command to optionally download only files
+  matching certain name, regexp, or range count.
+- Adds new ``verify-files`` command to verify number, size, and checksum of
+  downloaded files.
+- Improves ``get-metadata`` command with respect to outputting only
+  certain desired metadata field values.
+- Enriches user documentation.
+
+## 0.0.1 (2020-09-09)
+
+- Initial public release.

CHANGELOG.md

@@ -0,0 +1,22 @@
+# Contributing
+
+## Issues
+
+Bug reports, issues, feature requests, and other contributions are welcome. If you find
+a demonstrable problem that is caused by the `cernopendata-client`   code, please:
+
+1. Search for [already reported problems](https://github.com/cernopendata/cernopendata-client/issues).
+2. Check if the issue has been fixed or is still reproducible on the
+   latest `master` branch.
+3. Create an issue, ideally with **a test case**.
+
+## Pull requests
+
+If you create a pull request fixing a bug or implementing a feature, you can run
+the tests to ensure that everything is operating correctly:
+
+```console
+$ ./run-tests.sh
+```
+
+Each pull request should preserve or increase code coverage.

CHANGES.rst

@@ -1,6 +1,5 @@
 include *.json
 include *.md
-include *.rst
 include *.sh
 include *.yaml
 include .flake8
@@ -14,5 +13,5 @@ prune docs/_build
 recursive-include cernopendata_client *.py
 recursive-include docs *.png
 recursive-include docs *.py
-recursive-include docs *.rst
+recursive-include docs *.md
 recursive-include tests *.py

CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# cernopendata-client
+
+[![image](https://img.shields.io/pypi/pyversions/cernopendata-client.svg)](https://pypi.org/pypi/cernopendata-client)
+[![image](https://github.com/cernopendata/cernopendata-client/workflows/CI/badge.svg)](https://github.com/cernopendata/cernopendata-client/actions)
+[![image](https://readthedocs.org/projects/cernopendata-client/badge/?version=latest)](https://cernopendata-client.readthedocs.io/en/latest/?badge=latest)
+[![image](https://codecov.io/gh/cernopendata/cernopendata-client/branch/master/graph/badge.svg)](https://codecov.io/gh/cernopendata/cernopendata-client)
+[![image](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cernopendata/opendata.cern.ch?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![image](https://img.shields.io/github/license/cernopendata/cernopendata-client.svg)](https://github.com/cernopendata/cernopendata-client/blob/master/LICENSE)
+
+## About
+
+`cernopendata-client` is a command-line tool to facilitate downloading files
+from the [CERN Open Data portal](http://opendata.cern.ch/). The tool enables to
+query datasets hosted on the CERN Open Data portal and to download and verify
+the individual data set files.
+
+## Installation
+
+```console
+$ pip install cernopendata-client
+```
+
+## Usage
+
+The detailed information on how to install and use `cernopendata-client` can be
+found in
+[cernopendata-client.readthedocs.io](https://cernopendata-client.readthedocs.io/en/latest/).
+
+## Development
+
+1. Clone the repository:
+
+   ``` console
+   $ git clone https://github.com/cernopendata/cernopendata-client
+   ```
+
+2. Setup a [virtual environment](https://docs.python.org/3/library/venv.html):
+
+   ``` console
+   $ python3 -m venv env
+   $ source env/bin/activate
+   ```
+
+3. Install [cernopendata-client]{.title-ref} in [editable
+   mode](https://setuptools.pypa.io/en/latest/userguide/development_mode.html):
+
+   ```console
+   $ pip install -e '.[tests]'
+   ```
+
+## Useful links
+
+- [CERN Open Data portal](http://opendata.cern.ch/)
+- [CERN Open Data user forum](https://opendata-forum.cern.ch/)

MANIFEST.in

@@ -0,0 +1,2 @@
+```{include} ../AUTHORS.md
+```