Welcome to the documentation of the OSIS Reproducability Python Template!
===============================================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   :glob:

   source/*

|Latest Version| |Python 3.10+| |Documentation| |Code Style Black|
|codecov| |License| |GitHub|

This Project contains an example python package for the Advanced
Reproducibility Workshop (OSIS).

Introduction
------------

Hi there! Here is the right place for a brief introduction to the
project. The Documentation is available
`here <https://datascience-lmu.github.io/osis_python_repro/>`__.

   The random project logo was created with Stable Diffusion 2 (Rombach
   et al., 2022).

Installation
------------

-  Setup a virtual environment with ``python -m venv venv``
-  Activate the virtual environment with ``source venv/bin/activate``
-  Install the project with poetry ``poetry install`` (Have poetry
   installed)

Usage
-----

Populate this section with instructions on how to use the project.

Development Setup
-----------------

-  Install pre-commit hooks with ``pre-commit install``
-  Run tests with ``unittest`` with
   ``python -m unittest discover -s tests``

Contribution Guidelines
-----------------------

Populate this section with guidelines on how to contribute to the
project.

Citation
--------

If you use this project, please cite it as follows:

::

   @misc{osisPyRepr2024,
     author = {Emanuel Sommer and Tobias Weber and Lisa Wimmer},
     title = {Advanced Reproducibility Workshop - Python Package Template},
     year = {2024},
   }

License
-------

This project is licensed under the MIT License - see the
`LICENSE <LICENSE>`__ file for details.

.. |Latest Version| image:: https://img.shields.io/badge/version-0.1.0-g
.. |Python 3.10+| image:: https://img.shields.io/badge/python-3.10%2C%203.11%2C%203.12-blue?logo=python
.. |Documentation| image:: https://img.shields.io/badge/documentation-view-blue?logo=read-the-docs
   :target: https://datascience-lmu.github.io/osis_python_repro/
.. |Code Style Black| image:: https://img.shields.io/badge/code%20style-black-black
.. |codecov| image:: https://codecov.io/gh/DataScience-LMU/osis_python_repro/graph/badge.svg?token=DTLY6DO9OG
   :target: https://codecov.io/gh/DataScience-LMU/osis_python_repro
.. |License| image:: https://img.shields.io/badge/license-MIT-green
   :target: LICENSE
.. |GitHub| image:: https://img.shields.io/badge/GitHub-View%20on%20GitHub-lightgrey?logo=github
   :target: https://github.com/DataScience-LMU/osis_python_repro