From 5ed278d8f313b9fd68076efd91427b49df85910e Mon Sep 17 00:00:00 2001 From: Yannick DAYER <yannick.dayer@idiap.ch> Date: Thu, 11 May 2023 09:12:20 +0000 Subject: [PATCH] meta [readme]: Switch the README.rst to markdown. --- MANIFEST.in | 2 +- README.md | 33 +++++++++++++++++++++++++++++++++ README.rst | 41 ----------------------------------------- pyproject.toml | 2 +- 4 files changed, 35 insertions(+), 43 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/MANIFEST.in b/MANIFEST.in index 78ebbaf..52c9c04 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,3 @@ -include README.rst +include LICENSE README.md recursive-include doc *.rst *.png *.ico *.txt recursive-include bob *.csv *.json *.pgm diff --git a/README.md b/README.md new file mode 100644 index 0000000..2fff193 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +[](https://www.idiap.ch/software/bob/docs/bob/bob.pipelines/master/sphinx/index.html) +[](https://gitlab.idiap.ch/bob/bob.pipelines/commits/master) +[](https://www.idiap.ch/software/bob/docs/bob/bob.pipelines/master/coverage) +[](https://gitlab.idiap.ch/bob/bob.pipelines) + +# Tools to build robust and extensible pipelines + +This package is part of the signal-processing and machine learning toolbox +[Bob](https://www.idiap.ch/software/bob). + +The goal is to provide more flexible pipeline mechanisms for +[bob.bio.base](http://gitlab.idiap.ch/bob/bob.bio.base) and +[bob.pad.base](http://gitlab.idiap.ch/bob/bob.pad.base). + +It is based on the +[scikit-learn pipeline](https://scikit-learn.org/stable/modules/compose.html) +and adds a layer to route data and metadata through the pipeline (which is not +supported by scikit-learn yet). + +## Installation + +Complete bob's +[installation instructions](https://www.idiap.ch/software/bob/install). Then, +to install this package, run: + +``` sh +conda install bob.pipelines +``` + +## Contact + +For questions or reporting issues to this software package, contact our +development [mailing list](https://www.idiap.ch/software/bob/discuss). diff --git a/README.rst b/README.rst deleted file mode 100644 index 2a0a0c9..0000000 --- a/README.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. -*- coding: utf-8 -*- - -.. image:: https://img.shields.io/badge/docs-latest-orange.svg - :target: https://www.idiap.ch/software/bob/docs/bob/bob.pipelines/master/sphinx/index.html -.. image:: https://gitlab.idiap.ch/bob/bob.pipelines/badges/master/pipeline.svg - :target: https://gitlab.idiap.ch/bob/bob.pipelines/commits/master -.. image:: https://gitlab.idiap.ch/bob/bob.pipelines/badges/master/coverage.svg - :target: https://www.idiap.ch/software/bob/docs/bob/bob.pipelines/master/coverage -.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg - :target: https://gitlab.idiap.ch/bob/bob.pipelines - - -=========================================================================== - Tools to build robust and extensible pipelines -=========================================================================== - -This package is part of the signal-processing and machine learning toolbox Bob_. - -This is **STILL EXPERIMENTAL** and the goal is to provide more flexible pipeline mechanism for `bob.bio.base <http://gitlab.idiap.ch/bob/bob.bio.base>`_ and `bob.pad.base <http://gitlab.idiap.ch/bob/bob.pad.base>`_. - - -Installation ------------- - -Complete bob's `installation`_ instructions. Then, to install this -package, run:: - - $ conda install bob.pipelines - - -Contact -------- - -For questions or reporting issues to this software package, contact our -development `mailing list`_. - - -.. Place your references here: -.. _bob: https://www.idiap.ch/software/bob -.. _installation: https://www.idiap.ch/software/bob/install -.. _mailing list: https://www.idiap.ch/software/bob/discuss diff --git a/pyproject.toml b/pyproject.toml index 07adc9d..256a9b0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -68,7 +68,7 @@ package-dir = {"" = "src"} [tool.setuptools.dynamic] - readme = {file = "README.rst"} + readme = {file = "README.md", content-type = "text/markdown"} [project.entry-points."dask.client"] local-parallel = "bob.pipelines.config.distributed.local_parallel:dask_client" -- GitLab