Skip to content
Open
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
31 changes: 31 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
### EditorConfig settings
# Documentation: https://editorconfig.org
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.sh]
indent_style = tab
indent_size = 1

[*.py]
indent_style = space
indent_size = 4
max_line_length = 320 # matches `ruff` configuration

[*.{yml,yaml,json}]
indent_style = space
indent_size = 2

[*.{md,txt}]
indent_style = space
indent_size = 4
trim_trailing_whitespace = false

[*.mermaid]
indent_style = tab
indent_size = 1
19 changes: 19 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### Force text normalization and LF line endings
# Shell Scripts
*.sh text=auto eol=lf working-tree-encoding=UTF-8

# Python
*.py text=auto eol=lf working-tree-encoding=UTF-8

# YAML
*.yaml text=auto eol=lf working-tree-encoding=UTF-8
*.yml text=auto eol=lf working-tree-encoding=UTF-8

# Markdown
*.md text=auto eol=lf working-tree-encoding=UTF-8

# Mermaid
*.mermaid text=auto eol=lf working-tree-encoding=UTF-8

### Force detection of binaries
*.bin binary
32 changes: 19 additions & 13 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.14.5
hooks:
- id: ruff-format
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.14.5
hooks:
- id: ruff-format

- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
rev: 3.4.1
hooks:
- id: editorconfig-checker
alias: ec
12 changes: 6 additions & 6 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Copyright 2025 PRUSA RESEARCH A.S.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
Copyright 2025 PRUSA RESEARCH A.S.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# OpenPrintTag
This repository contains specification, documentation and utility scripts for the [OpenPrintTag](https://openprinttag.org) format.
**This is a "raw" repository, you can access the compiled documentation on [specs.openprinttag.org](https://specs.openprinttag.org)**
(or use generate_docs.sh to generate a website into the docs folder)
## Directory structure
* `data`: Machine-readable specification data (field & enum definitions, ...)
* `docs_src`: Source code for the [specs.openprinttag.org](https://specs.openprinttag.org) website
* `tests`: Tests
* `utils`: Reference implementation for the format in Python
## Generating documentation
To generate documentation (to the `docs` directory), run:
```python
pip3 install -r requirements.txt
sh generate_docs.sh
```
Then, to view it, you can:
```
cd docs
python3 -m http.server
```
and open your browser on `127.0.0.1:8000`
# OpenPrintTag
This repository contains specification, documentation and utility scripts for the [OpenPrintTag](https://openprinttag.org) format.

**This is a "raw" repository, you can access the compiled documentation on [specs.openprinttag.org](https://specs.openprinttag.org)**

(or use generate_docs.sh to generate a website into the docs folder)

## Directory structure
* `data`: Machine-readable specification data (field & enum definitions, ...)
* `docs_src`: Source code for the [specs.openprinttag.org](https://specs.openprinttag.org) website
* `tests`: Tests
* `utils`: Reference implementation for the format in Python

## Generating documentation
To generate documentation (to the `docs` directory), run:
```python
pip3 install -r requirements.txt
sh generate_docs.sh
```

Then, to view it, you can:
```
cd docs
python3 -m http.server
```
and open your browser on `127.0.0.1:8000`
Loading