Metadata-Version: 2.4
Name: urnc
Version: 2.2.2
Summary: A package to convert UR FIDS jupyter notebooks
Author-email: Michael Huttner <michael@mhuttner.com>, Tobias Schmidt <tobias.schmidt331@gmail.com>
Project-URL: Homepage, https://spang-lab.github.io/urnc
Project-URL: Source, https://github.com/spang-lab/urnc
Project-URL: Bug Tracker, https://github.com/spang-lab/urnc/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.1.3
Requires-Dist: python-dateutil>=2.8.0
Requires-Dist: GitPython>=3.1.31
Requires-Dist: nbconvert>=7.16.6
Requires-Dist: semver>=3.0.1
Requires-Dist: ruamel.yaml>=0.18.4
Requires-Dist: requests>=2.31.0
Requires-Dist: papermill>=2.4.0
Requires-Dist: ipykernel>=6.29.5
Provides-Extra: dev
Requires-Dist: sphinx>=4.0.0; extra == "dev"
Requires-Dist: sphinx_rtd_theme>=3.0.2; extra == "dev"
Requires-Dist: myst_parser>=0.18.0; extra == "dev"
Requires-Dist: toml>=0.10.2; extra == "dev"
Requires-Dist: pytest>=8.3.5; extra == "dev"
Requires-Dist: pytest-cov>=6.1.1; extra == "dev"
Requires-Dist: freezegun>=1.5.1; extra == "dev"
Requires-Dist: PyYAML>=6.0.2; extra == "dev"
Requires-Dist: pytest-xdist>=3.6.1; extra == "dev"
Requires-Dist: autopep8>=2.3.2; extra == "dev"
Dynamic: license-file

[![Test Badge](https://github.com/spang-lab/urnc/actions/workflows/test.yaml/badge.svg)](https://github.com/spang-lab/urnc/actions)
[![Coverage Badge](https://img.shields.io/codecov/c/github/spang-lab/urnc?label=Code%20Coverage)](https://app.codecov.io/gh/spang-lab/urnc?branch=main)
[![Download Badge](https://img.shields.io/pypi/dm/urnc.svg?label=PyPI%20Downloads)](
https://pypi.org/project/urnc/)

# URNC

Uni Regensburg Notebook Converter

## Installation

```sh
pip install urnc
```

Or update from an older version:

```sh
pip install urnc --upgrade
```

## Usage

```sh
# Clone example course and change into course directory
git clone https://github.com/spang-lab/urnc-example-course
cd urnc-example-course

# Convert a single notebook to student version
urnc convert assignments/sheet1.ipynb student/sheet1.ipynb

# Convert all assignment notebooks to student versions
urnc convert assignments

# Convert all assignment notebooks to student version, pull student repo and
# copy over converted notebooks
urnc student
```

You can find a more detailed introduction to URNC at page [Usage](https://spang-lab.github.io/urnc/usage.html) of URNC's [Documentation Website](https://spang-lab.github.io/urnc/).

## Documentation

You can find the full documentation for URNC at [spang-lab.github.io/urnc](https://spang-lab.github.io/urnc/). Amongst others, it includes chapters about:

- [Installation](https://spang-lab.github.io/urnc/installation.html)
- [Usage](https://spang-lab.github.io/urnc/usage.html)
- [Commands](https://spang-lab.github.io/urnc/commands/index.html)
- [Configuration](https://spang-lab.github.io/urnc/configuration.html)
- [Contributing](https://spang-lab.github.io/urnc/contributing.html)
- [Changelog](https://spang-lab.github.io/urnc/changelog.html)
