Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -205,3 +205,7 @@ cython_debug/
marimo/_static/
marimo/_lsp/
__marimo__/

# Jupyter Book
_build/
.jupyter_cache/
25 changes: 25 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.PHONY: help build clean serve install

help:
@echo "Available targets:"
@echo " install - Install dependencies"
@echo " build - Build the Jupyter Book"
@echo " clean - Remove built book files"
@echo " serve - Serve the book locally (after building)"

install:
pip install -r requirements.txt

build:
jupyter-book build .

clean:
jupyter-book clean .

serve:
@echo "Opening book in browser..."
@if [ -d "_build/html" ]; then \
python -m http.server --directory _build/html 8000; \
else \
echo "Error: Book not built yet. Run 'make build' first."; \
fi
99 changes: 97 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,97 @@
# tutorials
Tutorials using rudof
# Rudof Tutorials

This repository contains tutorials for learning and using Rudof, a Rust-based RDF validation tool. The tutorials are built using [Jupyter Book](https://jupyterbook.org/).

## Quick Start

### Prerequisites

- Python 3.8 or higher
- pip (Python package installer)

### Installation

1. Clone this repository:
```bash
git clone https://github.com/rudof-project/tutorials.git
cd tutorials
```

2. Install dependencies:
```bash
pip install -r requirements.txt
```

Or use the Makefile:
```bash
make install
```

### Building the Book

To build the Jupyter Book:

```bash
jupyter-book build .
```

Or use the Makefile:
```bash
make build
```

The built HTML files will be in the `_build/html/` directory.

### Viewing the Book

After building, you can view the book by opening `_build/html/index.html` in your web browser, or serve it locally:

```bash
make serve
```

Then open http://localhost:8000 in your browser.

## Tutorial Contents

The tutorials cover:

1. **Getting Started** - Installation and setup of Rudof
2. **Basic Usage** - Fundamental concepts and operations
3. **Advanced Features** - Advanced use cases and optimization

## Development

### Adding New Tutorials

1. Create a new markdown file in the `tutorials/` directory
2. Add the file to `_toc.yml` in the appropriate location
3. Build the book to see your changes

### Cleaning Build Files

To remove all built files:

```bash
jupyter-book clean .
```

Or use the Makefile:
```bash
make clean
```

## Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Resources

- [Rudof Project](https://github.com/rudof-project/rudof)
- [Jupyter Book Documentation](https://jupyterbook.org/)
- [ShEx Specification](http://shex.io/)
- [SHACL Specification](https://www.w3.org/TR/shacl/)
30 changes: 30 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Book settings
title: Rudof Tutorials
author: Rudof Project
logo: logo.png
copyright: "2025"

# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
execute_notebooks: auto

# Define the name of the latex output file for PDF builds
latex:
latex_documents:
targetname: book.tex

# Add a bibtex file so that we can create citations
bibtex_bibfiles:
- references.bib

# Information about where the book exists on the web
repository:
url: https://github.com/rudof-project/tutorials
path_to_book: .
branch: main

# Add GitHub buttons to your book
html:
use_issues_button: true
use_repository_button: true
9 changes: 9 additions & 0 deletions _toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Table of contents
# Learn more at https://jupyterbook.org/customize/toc.html

format: jb-book
root: intro
chapters:
- file: tutorials/getting-started
- file: tutorials/basic-usage
- file: tutorials/advanced-features
33 changes: 33 additions & 0 deletions intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Welcome to Rudof Tutorials

Welcome to the Rudof tutorials! This collection of tutorials will help you get started with Rudof and explore its features.

## What is Rudof?

Rudof is a Rust-based validation and processing tool for RDF data. It provides powerful capabilities for working with semantic web technologies.

## Tutorial Contents

This book contains the following tutorials:

1. **Getting Started**: Learn how to install and set up Rudof
2. **Basic Usage**: Understand the basic concepts and commands
3. **Advanced Features**: Explore advanced features and use cases

## Prerequisites

Before starting these tutorials, you should have:

- Basic understanding of RDF and semantic web concepts
- Rust installed on your system (for building from source)
- Familiarity with command-line tools

## Getting Help

If you encounter any issues or have questions:

- Visit the [GitHub repository](https://github.com/rudof-project/tutorials)
- Check the [main Rudof project](https://github.com/rudof-project/rudof)
- Open an issue for any problems or suggestions

Let's get started!
10 changes: 10 additions & 0 deletions logo.png.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Logo Placeholder

To add a logo for your Jupyter Book:

1. Replace this file with an actual `logo.png` image file
2. The logo will appear in the top-left corner of your book
3. Recommended size: 200x200 pixels or similar square dimensions
4. PNG format is recommended for best quality

For now, the book will work without a logo, but it's recommended to add one for a professional appearance.
21 changes: 21 additions & 0 deletions references.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
@article{rudof2025,
title={Rudof: A Rust-based RDF Validation Tool},
author={Rudof Project Contributors},
year={2025},
url={https://github.com/rudof-project/rudof}
}

@misc{shex2014,
title={Shape Expressions (ShEx) 2.1 Primer},
author={Eric Prud'hommeaux and Iovka Boneva and Jose Emilio Labra Gayo and Gregg Kellogg},
year={2014},
url={http://shex.io/shex-primer/}
}

@misc{shacl2017,
title={Shapes Constraint Language (SHACL)},
author={Holger Knublauch and Dimitris Kontokostas},
year={2017},
publisher={W3C},
url={https://www.w3.org/TR/shacl/}
}
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
jupyter-book>=0.15.0
matplotlib
numpy
Loading