Metadata-Version: 2.1
Name: cernopendata-client
Version: 0.3.0
Summary: cernopendata-client.
Home-page: UNKNOWN
Author: CERN Open Data
Author-email: opendata-team@cern.ch
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Archiving
Provides-Extra: docs
Provides-Extra: tests
Provides-Extra: xrootd
Provides-Extra: pycurl
Provides-Extra: all
License-File: LICENSE
License-File: AUTHORS.rst

###################
cernopendata-client
###################

.. image:: https://img.shields.io/pypi/pyversions/cernopendata-client.svg
   :target: https://pypi.org/pypi/cernopendata-client

.. image:: https://github.com/cernopendata/cernopendata-client/workflows/CI/badge.svg
   :target: https://github.com/cernopendata/cernopendata-client/actions

.. image:: https://readthedocs.org/projects/cernopendata-client/badge/?version=latest
   :target: https://cernopendata-client.readthedocs.io/en/latest/?badge=latest

.. image:: https://codecov.io/gh/cernopendata/cernopendata-client/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/cernopendata/cernopendata-client

.. image:: https://badges.gitter.im/Join%20Chat.svg
   :target: 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
   :target: https://github.com/cernopendata/cernopendata-client/blob/master/LICENSE

About
=====

``cernopendata-client`` is a command-like 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
============

.. code-block:: 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/>`_.

Useful links
============

- `CERN Open Data portal <http://opendata.cern.ch/>`_
- `CERN Open Data user forum <https://opendata-forum.cern.ch/>`_


Changes
=======

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


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

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

Version 0.0.1 (2020-09-09)
--------------------------

- Initial public release.


