Metadata-Version: 2.1
Name: smk2rst
Version: 0.1.0
Summary: Utility to translate Snakemake codebase into sphinx-like rst files
Home-page: https://git.km3net.de/km3py/smk2rst.git
Author: Valentin Pestel
Author-email: vpestel@km3net.de
Maintainer: Valentin Pestel
Maintainer-email: vpestel@km3net.de
License: MIT
Keywords: neutrino,astroparticle,physics,HEP
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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: Topic :: Scientific/Engineering
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: setuptools_scm
Requires-Dist: RstCloth
Provides-Extra: all
Requires-Dist: black; extra == "all"
Requires-Dist: ipykernel; extra == "all"
Requires-Dist: pillow; extra == "all"
Requires-Dist: pytest; extra == "all"
Requires-Dist: pytest-cov; extra == "all"
Requires-Dist: pytest-flake8; extra == "all"
Requires-Dist: pylint; extra == "all"
Requires-Dist: pytest-watch; extra == "all"
Requires-Dist: sphinx; extra == "all"
Requires-Dist: sphinx-autoapi; extra == "all"
Requires-Dist: sphinx_rtd_theme; extra == "all"
Requires-Dist: sphinxcontrib-versioning; extra == "all"
Requires-Dist: wheel; extra == "all"
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: ipykernel; extra == "dev"
Requires-Dist: pillow; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-flake8; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: pytest-watch; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx-autoapi; extra == "dev"
Requires-Dist: sphinx_rtd_theme; extra == "dev"
Requires-Dist: sphinxcontrib-versioning; extra == "dev"
Requires-Dist: wheel; extra == "dev"

Utility to translate Snakemake codebase into sphinx-like rst files
==================================================================

.. image:: git@git.km3net.de:km3py/smk2rst.git/badges/master/pipeline.svg
    :target: git@git.km3net.de:km3py/smk2rst.git/pipelines

.. image:: git@git.km3net.de:km3py/smk2rst.git/badges/master/coverage.svg
    :target: https://vpestel.pages.km3net.de/smk2rst/coverage

.. image:: https://git.km3net.de/examples/km3badges/-/raw/master/docs-latest-brightgreen.svg
    :target: https://vpestel.pages.km3net.de/smk2rst


Installation
~~~~~~~~~~~~

It is recommended to first create an isolated virtualenvironment to not interfere
with other Python projects::

  git clone git@git.km3net.de:km3py/smk2rst.git
  cd smk2rst
  python3 -m venv venv
  . venv/bin/activate

Install directly from the Git server via ``pip`` (no cloneing needed)::

  pip install git+git@git.km3net.de:km3py/smk2rst.git

Or clone the repository and run::

  make install

To install all the development dependencies, in case you want to contribute or
run the test suite::

  make install-dev
  make test


---

*Created with ``cookiecutter https://git.km3net.de/templates/python-project``*
