PyPI - opengate-gate-macro-fold - Versions diffs - 0.1.2__tar.gz - Mend

opengate-gate-macro-fold 0.1.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (32) hide show

opengate_gate_macro_fold-0.1.2/.github/PULL_REQUEST_TEMPLATE.md ADDED Viewed

@@ -0,0 +1,27 @@
+## Description
+Brief description of what this PR does.
+## Related Issues
+Closes #123
+Related to #456
+## Changes
+- Change 1
+- Change 2
+- Change 3
+## Type of Change
+- [ ] Bug fix (non-breaking)
+- [ ] New feature (non-breaking)
+- [ ] Breaking change
+- [ ] Documentation update
+## Testing
+Describe tests added or how changes were tested.
+## Checklist
+- [ ] Code follows style guidelines
+- [ ] Tests added and passing
+- [ ] Documentation updated
+- [ ] Commit messages are clear
+- [ ] No merge conflicts

opengate_gate_macro_fold-0.1.2/.github/get_review.sh ADDED Viewed

@@ -0,0 +1,119 @@
+#!/usr/bin/env bash
+set -euo pipefail
+if ! command -v gh >/dev/null 2>&1; then
+  echo "Error: required tool 'gh' is not installed." >&2
+  exit 1
+fi
+if ! command -v jq >/dev/null 2>&1; then
+  echo "Error: required tool 'jq' is not installed." >&2
+  exit 1
+fi
+if ! gh auth status >/dev/null 2>&1; then
+  echo "Error: you are not signed in to gh. Run: gh auth login" >&2
+  exit 1
+fi
+BRANCH="$(git rev-parse --abbrev-ref HEAD)"
+REPO_FULL="$(gh repo view --json nameWithOwner -q .nameWithOwner)"
+OWNER="${REPO_FULL%/*}"
+REPO="${REPO_FULL#*/}"
+OUTPUT_DIR=".tmp/code-reviews"
+mkdir -p "$OUTPUT_DIR"
+BRANCH_SAFE="$(echo "$BRANCH" | sed -E 's/[^A-Za-z0-9._-]+/-/g')"
+if [[ -z "$BRANCH_SAFE" ]]; then
+  BRANCH_SAFE="unknown-branch"
+fi
+FETCH_DATE="$(date '+%Y%m%d-%H%M%S')"
+FETCH_DAY="${FETCH_DATE%%-*}"
+EXISTING_COUNT="$({
+  find "$OUTPUT_DIR" -maxdepth 1 -type f \
+    -name "pr-code-review-${BRANCH_SAFE}-${FETCH_DAY}-*.md"
+} | wc -l | tr -d '[:space:]')"
+ORDER_NUMBER="$(printf '%02d' "$((EXISTING_COUNT + 1))")"
+OUTPUT_FILE="${OUTPUT_DIR}/pr-code-review-${BRANCH_SAFE}-${FETCH_DATE}-${ORDER_NUMBER}.md"
+PRS_JSON="$(gh pr list --state open --head "$BRANCH" --json number,title,url,headRefName,author 2>/dev/null || true)"
+if [[ -z "$PRS_JSON" || "$PRS_JSON" == "[]" ]]; then
+  {
+    echo "# Review tasks"
+    echo
+    echo "No open PR found for branch: $BRANCH."
+  } >"$OUTPUT_FILE"
+  echo "Saved: $OUTPUT_FILE"
+  exit 0
+fi
+PR_NUMBERS="$(echo "$PRS_JSON" | jq -r '.[].number')"
+FIRST_PR_NUMBER="$(echo "$PR_NUMBERS" | head -n1)"
+GRAPHQL_QUERY='query($owner:String!, $repo:String!, $number:Int!) {
+  repository(owner:$owner, name:$repo) {
+    pullRequest(number:$number) {
+      number
+      title
+      url
+      headRefName
+      reviewThreads(first: 100) {
+        nodes {
+          isResolved
+          isOutdated
+          path
+          line
+          startLine
+          comments(first: 100) {
+            nodes {
+              author { login }
+              body
+              url
+              createdAt
+            }
+          }
+        }
+      }
+    }
+  }
+}'
+PR_JSON="$(gh api graphql -f query="$GRAPHQL_QUERY" -F owner="$OWNER" -F repo="$REPO" -F number="$FIRST_PR_NUMBER")"
+UNRESOLVED_COUNT="$(echo "$PR_JSON" | jq '[.data.repository.pullRequest.reviewThreads.nodes[] | select(.isResolved == false)] | length')"
+{
+  echo "# Review tasks"
+  echo
+  echo "Repository: \`$REPO_FULL\`  "
+  echo "Branch: \`$BRANCH\`  "
+  echo "PR: [#${FIRST_PR_NUMBER}]($(echo "$PR_JSON" | jq -r '.data.repository.pullRequest.url')) - $(echo "$PR_JSON" | jq -r '.data.repository.pullRequest.title')"
+  echo
+  echo "## Unresolved threads"
+  echo
+  if [[ "$UNRESOLVED_COUNT" -eq 0 ]]; then
+    echo "No unresolved threads ✅"
+  else
+    echo "$PR_JSON" | jq -r '
+      .data.repository.pullRequest.reviewThreads.nodes
+      | map(select(.isResolved == false))
+      | to_entries[]
+      | .value as $t
+      | $t.comments.nodes[0] as $c
+      | "- [ ] "
+        + "[" + ($t.path // "(brak pliku)")
+        + (if ($t.line // $t.startLine) then ":L" + (($t.line // $t.startLine)|tostring) else "" end)
+        + "](" + ($c.url // "") + ")"
+        + " — @" + ($c.author.login // "unknown")
+        + (if $t.isOutdated then " *(outdated)*" else "" end)
+        + "\n  > " + (($c.body // "") | gsub("\n"; " ") | gsub("\r"; " ") | .[0:50000])
+    '
+  fi
+} >"$OUTPUT_FILE"
+echo "Saved: $OUTPUT_FILE"

opengate_gate_macro_fold-0.1.2/.github/workflows/ci.yaml ADDED Viewed

@@ -0,0 +1,48 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    branches:
+      - main
+      - develop
+  workflow_dispatch:
+permissions:
+  contents: read
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  check:
+    name: check (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: make init
+      - name: Run full validation
+        run: make check

opengate_gate_macro_fold-0.1.2/.github/workflows/publish.yml ADDED Viewed

@@ -0,0 +1,32 @@
+name: publish
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Build sdist and wheel
+        run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

opengate_gate_macro_fold-0.1.2/.gitignore ADDED Viewed

@@ -0,0 +1,16 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+htmlcov/
+.venv/
+venv/
+.env
+.tmp/
+examples/output/
+uv.lock
+.claude/

opengate_gate_macro_fold-0.1.2/.pre-commit-config.yaml ADDED Viewed

@@ -0,0 +1,10 @@
+repos:
+  - repo: local
+    hooks:
+      - id: make-check
+        name: Run make check
+        entry: make check
+        language: system
+        pass_filenames: false
+        always_run: true
+        stages: [pre-commit]

opengate_gate_macro_fold-0.1.2/LICENSE ADDED Viewed

@@ -0,0 +1,23 @@
+# MIT License
+**Project:** opengate-gate-macro-fold
+Copyright (c) 2026 Mateusz Jakub Bała
+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.

opengate_gate_macro_fold-0.1.2/Makefile ADDED Viewed

@@ -0,0 +1,108 @@
+# FILE: Makefile
+# ABOUT: Project helper tasks: installation, validation, and worktree
+#        management for feature branches created from develop.
+# USAGE:
+#   make init | install | install-user | test | lint | format | typecheck | check
+#   make worktree BRANCH_NAME=feature/description
+#   make switch-to-worktree BRANCH_NAME=feature/description
+SHELL := /bin/bash
+# Parent directory for worktrees and directory for lock files.
+WORKTREE_ROOT ?= ../worktrees
+WORKTREE_LOCKS_DIR ?= .tmp/worktree-locks
+.PHONY: init install install-user test lint format typecheck check worktree switch-to-worktree
+# Install dependencies and create the virtual environment (uv).
+init:
+	uv sync
+# Install project dependencies and package into the local .venv.
+install: init
+	@echo "Installed in local virtual environment: .venv"
+	@echo "Run via uv: uv run opengate-gate-macro-fold --help"
+	@echo "Or activate the environment: source .venv/bin/activate"
+# Install the package for the current user (outside project .venv).
+install-user:
+	python3 -m pip install --user -e .
+	@echo "Installed in user site-packages (--user)."
+	@echo "If needed, add ~/.local/bin to PATH."
+# Run the full test suite.
+test:
+	uv run pytest
+# Check code style (lint).
+lint:
+	uv run ruff check
+# Format code.
+format:
+	uv run ruff format
+# Static type checking.
+typecheck:
+	uv run mypy src/
+# Full local validation: lint, formatting check, types, tests.
+check:
+	uv run ruff check
+	uv run ruff format --check
+	uv run mypy src/
+	uv run pytest
+# Create a worktree for the given branch if it does not already exist.
+worktree:
+	@if [[ -z "$(BRANCH_NAME)" ]]; then \
+		echo "Error: set BRANCH_NAME, e.g. make worktree BRANCH_NAME=worktree/branch/name." >&2; \
+		exit 1; \
+	fi
+	@WORKTREE_DIR="$(WORKTREE_ROOT)/$$(echo "$(BRANCH_NAME)" | tr '/' '-')"; \
+	mkdir -p "$(WORKTREE_ROOT)"; \
+	if git worktree list --porcelain | grep -Fxq "branch refs/heads/$(BRANCH_NAME)"; then \
+		echo "Worktree for branch $(BRANCH_NAME) already exists."; \
+		exit 0; \
+	fi; \
+	if git show-ref --verify --quiet "refs/heads/$(BRANCH_NAME)"; then \
+		git worktree add "$$WORKTREE_DIR" "$(BRANCH_NAME)"; \
+	else \
+		git worktree add -b "$(BRANCH_NAME)" "$$WORKTREE_DIR" develop; \
+	fi; \
+	echo "Created worktree: $$WORKTREE_DIR (branch: $(BRANCH_NAME))."
+# Switch to an existing worktree if it is not locked by another instance.
+switch-to-worktree:
+	@if [[ -z "$(BRANCH_NAME)" ]]; then \
+		echo "Error: set BRANCH_NAME, e.g. make switch-to-worktree BRANCH_NAME=worktree/branch/name." >&2; \
+		exit 1; \
+	fi
+	@if ! git show-ref --verify --quiet "refs/heads/$(BRANCH_NAME)"; then \
+		echo "Error: the specified branch does not exist: $(BRANCH_NAME)." >&2; \
+		exit 1; \
+	fi
+	@WORKTREE_DIR="$$(git worktree list --porcelain | awk -v target="refs/heads/$(BRANCH_NAME)" '\
+		$$1=="worktree" { path=$$2 } \
+		$$1=="branch" && $$2==target { print path; exit }')"; \
+	if [[ -z "$$WORKTREE_DIR" ]]; then \
+		echo "Error: no worktree exists for branch $(BRANCH_NAME). First run make worktree BRANCH_NAME=$(BRANCH_NAME)." >&2; \
+		exit 1; \
+	fi; \
+	LOCK_FILE="$(WORKTREE_LOCKS_DIR)/$$(echo "$(BRANCH_NAME)" | tr '/' '-').lock"; \
+	mkdir -p "$(WORKTREE_LOCKS_DIR)"; \
+	if [[ -f "$$LOCK_FILE" ]]; then \
+		LOCK_PID="$$(cat "$$LOCK_FILE")"; \
+		if [[ -n "$$LOCK_PID" ]] && kill -0 "$$LOCK_PID" 2>/dev/null; then \
+			echo "Error: the worktree is already locked by another instance (PID: $$LOCK_PID)." >&2; \
+			echo "How to release it: stop the process with PID $$LOCK_PID (for example, close the shell holding the lock)." >&2; \
+			exit 1; \
+		fi; \
+		rm -f "$$LOCK_FILE"; \
+	fi; \
+	echo "$$BASHPID" > "$$LOCK_FILE"; \
+	cleanup() { rm -f "$$LOCK_FILE"; }; \
+	trap cleanup EXIT INT TERM; \
+	echo "Switched to $$WORKTREE_DIR. To release the lock, close this shell."; \
+	cd "$$WORKTREE_DIR"; \
+	"$${SHELL:-/bin/bash}" -i

opengate_gate_macro_fold-0.1.2/PKG-INFO ADDED Viewed

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: opengate-gate-macro-fold
+Version: 0.1.2
+Summary: Folding and unfolding GATE 9 macros - from mono macro to set of macros and vice versa
+Project-URL: Homepage, https://github.com/MateuszBala/opengate-gate-macro-fold
+Project-URL: Repository, https://github.com/MateuszBala/opengate-gate-macro-fold
+Author: Mateusz Jakub Bała
+License-Expression: MIT
+License-File: LICENSE
+Keywords: gate,macro,monte-carlo,opengate,simulation
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+# opengate-gate-macro-fold
+[![CI](https://github.com/MateuszBala/opengate-gate-macro-fold/actions/workflows/ci.yaml/badge.svg)](https://github.com/MateuszBala/opengate-gate-macro-fold/actions/workflows/ci.yaml)
+[![Version](https://img.shields.io/badge/version-0.1.2-informational)](https://github.com/MateuszBala/opengate-gate-macro-fold/releases)
+[![Standard Python](https://img.shields.io/badge/Python-3.11-blue?logo=python&logoColor=white)]()
+[![Standard Python](https://img.shields.io/badge/Python-3.12-blue?logo=python&logoColor=white)]()
+[![Standard Python](https://img.shields.io/badge/Python-3.13-blue?logo=python&logoColor=white)]()
+[![Standard Python](https://img.shields.io/badge/Python-3.14-blue?logo=python&logoColor=white)]()
+[![license](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+`opengate-gate-macro-fold` is a utility for managing [GATE 9](https://github.com/OpenGATE/Gate) simulation macro files. It supports:
+- **Folding**: combining a directory of macro files into a single mono macro file.
+- **Unfolding**: splitting a mono macro file into a directory of macro files.
+This workflow is practical when switching between batch execution environments (for example, clusters) and local or interactive simulation workflows.
+## Quick Start
+### Install From PyPI
+```bash
+pip3 install opengate-gate-macro-fold
+```
+### Install From Source
+```bash
+make init
+make install
+```
+### Fold A Macro Set Into A Mono Macro
+```bash
+opengate-gate-macro-fold \
+  --fold \
+  --input-macros-dir=path/to/macros/directory \
+  --output-dir=path/to/output/directory \
+  [--title="my-mono-macro.mac"]
+```
+### Unfold A Mono Macro Into A Macro Set
+```bash
+opengate-gate-macro-fold \
+  --unfold \
+  --input-mono-macro-file=path/to/mono/macro.mac \
+  --output-dir=path/to/output/directory
+```
+## Command-Line Options
+- `--fold`: enable fold mode (macro set -> mono macro).
+- `--unfold`: enable unfold mode (mono macro -> macro set).
+- `--input-macros-dir`: source directory used in fold mode.
+- `--input-mono-macro-file`: source mono macro file used in unfold mode.
+- `--output-dir`: destination directory for generated output.
+- `--title`: optional title metadata for mono macro output.
+## Development
+Common development commands:
+```bash
+make lint
+make format
+make typecheck
+make test
+make check
+```
+### Pre-commit setup
+You can install and activate `pre-commit` in two supported ways.
+#### Option A (recommended): use `uv` in this repository
+```bash
+uv add --dev pre-commit
+uv sync
+uv run pre-commit install --hook-type pre-commit
+```
+Optional one-time verification on all files:
+```bash
+uv run pre-commit run --all-files
+```
+#### Option B: install `pre-commit` from Debian packages
+```bash
+sudo apt update
+sudo apt install -y pre-commit
+pre-commit --version
+pre-commit install --hook-type pre-commit
+```
+Optional one-time verification on all files:
+```bash
+pre-commit run --all-files
+```
+The configured hook runs `make check` before each commit and blocks the commit if validation fails.
+Project conventions and contribution standards:
+- [Coding conventions](docs/CODING_CONVENTIONS.md)
+- [Testing conventions](docs/TESTING_CONVENTIONS.md)
+- [Commit conventions](docs/COMMIT_CONVENTIONS.md)
+- [Contribution guide](docs/CONTRIBUTION.md)
+## License
+MIT License
+Contact: [GitHub](https://github.com/MateuszBala)
+## Author
+The project was designed and implemented by Mateusz Jakub Bała.
+Contact: [GitHub](https://github.com/MateuszBala)
+## Contribution
+To contribute new functionality:
+- create a branch from `develop`
+- follow the [commit conventions](docs/COMMIT_CONVENTIONS.md)
+- open a PR using the [PR template](.github/PULL_REQUEST_TEMPLATE.md)
+- follow the [contribution guide](docs/CONTRIBUTION.md)

opengate_gate_macro_fold-0.1.2/README.md ADDED Viewed

@@ -0,0 +1,138 @@
+# opengate-gate-macro-fold
+[![CI](https://github.com/MateuszBala/opengate-gate-macro-fold/actions/workflows/ci.yaml/badge.svg)](https://github.com/MateuszBala/opengate-gate-macro-fold/actions/workflows/ci.yaml)
+[![Version](https://img.shields.io/badge/version-0.1.2-informational)](https://github.com/MateuszBala/opengate-gate-macro-fold/releases)
+[![Standard Python](https://img.shields.io/badge/Python-3.11-blue?logo=python&logoColor=white)]()
+[![Standard Python](https://img.shields.io/badge/Python-3.12-blue?logo=python&logoColor=white)]()
+[![Standard Python](https://img.shields.io/badge/Python-3.13-blue?logo=python&logoColor=white)]()
+[![Standard Python](https://img.shields.io/badge/Python-3.14-blue?logo=python&logoColor=white)]()
+[![license](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+`opengate-gate-macro-fold` is a utility for managing [GATE 9](https://github.com/OpenGATE/Gate) simulation macro files. It supports:
+- **Folding**: combining a directory of macro files into a single mono macro file.
+- **Unfolding**: splitting a mono macro file into a directory of macro files.
+This workflow is practical when switching between batch execution environments (for example, clusters) and local or interactive simulation workflows.
+## Quick Start
+### Install From PyPI
+```bash
+pip3 install opengate-gate-macro-fold
+```
+### Install From Source
+```bash
+make init
+make install
+```
+### Fold A Macro Set Into A Mono Macro
+```bash
+opengate-gate-macro-fold \
+  --fold \
+  --input-macros-dir=path/to/macros/directory \
+  --output-dir=path/to/output/directory \
+  [--title="my-mono-macro.mac"]
+```
+### Unfold A Mono Macro Into A Macro Set
+```bash
+opengate-gate-macro-fold \
+  --unfold \
+  --input-mono-macro-file=path/to/mono/macro.mac \
+  --output-dir=path/to/output/directory
+```
+## Command-Line Options
+- `--fold`: enable fold mode (macro set -> mono macro).
+- `--unfold`: enable unfold mode (mono macro -> macro set).
+- `--input-macros-dir`: source directory used in fold mode.
+- `--input-mono-macro-file`: source mono macro file used in unfold mode.
+- `--output-dir`: destination directory for generated output.
+- `--title`: optional title metadata for mono macro output.
+## Development
+Common development commands:
+```bash
+make lint
+make format
+make typecheck
+make test
+make check
+```
+### Pre-commit setup
+You can install and activate `pre-commit` in two supported ways.
+#### Option A (recommended): use `uv` in this repository
+```bash
+uv add --dev pre-commit
+uv sync
+uv run pre-commit install --hook-type pre-commit
+```
+Optional one-time verification on all files:
+```bash
+uv run pre-commit run --all-files
+```
+#### Option B: install `pre-commit` from Debian packages
+```bash
+sudo apt update
+sudo apt install -y pre-commit
+pre-commit --version
+pre-commit install --hook-type pre-commit
+```
+Optional one-time verification on all files:
+```bash
+pre-commit run --all-files
+```
+The configured hook runs `make check` before each commit and blocks the commit if validation fails.
+Project conventions and contribution standards:
+- [Coding conventions](docs/CODING_CONVENTIONS.md)
+- [Testing conventions](docs/TESTING_CONVENTIONS.md)
+- [Commit conventions](docs/COMMIT_CONVENTIONS.md)
+- [Contribution guide](docs/CONTRIBUTION.md)
+## License
+MIT License
+Contact: [GitHub](https://github.com/MateuszBala)
+## Author
+The project was designed and implemented by Mateusz Jakub Bała.
+Contact: [GitHub](https://github.com/MateuszBala)
+## Contribution
+To contribute new functionality:
+- create a branch from `develop`
+- follow the [commit conventions](docs/COMMIT_CONVENTIONS.md)
+- open a PR using the [PR template](.github/PULL_REQUEST_TEMPLATE.md)
+- follow the [contribution guide](docs/CONTRIBUTION.md)