feat: initial commit

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material mkdocs-macros-plugin
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1,176 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

README.md

@@ -0,0 +1,40 @@
+## Inteliver Documentation
+
+Inteliver is an open-source image management framework that allows you to store, modify, and deliver optimized images. 
+
+This README provides instructions to set up and build the documentation for Inteliver using MkDocs.
+
+### Installation
+
+1. Create a new Conda environment with Python 3.11:
+    ```bash
+    conda create -n mkdocs python=3.11
+    ```
+
+2. Activate the environment:
+    ```bash
+    conda activate mkdocs
+    ```
+
+3. Install MkDocs Material and MkDocs Macros Plugin:
+    ```bash
+    pip install mkdocs-material mkdocs-macros-plugin
+    ```
+
+### Serving the Documentation
+
+To serve the documentation locally:
+
+```bash
+mkdocs serve
+```
+
+### Building the Static Website
+
+To build the static website:
+
+```bash
+mkdocs build
+```
+
+This will create a `site` directory with your static documentation website ready to be hosted.

docs/api-reference/blur.md

@@ -0,0 +1,22 @@
+---
+title: "Blur"
+---
+
+### Blur Operation
+
+<table>
+  <tr>
+    <th>Command</th>
+    <th>Details</th>
+  </tr>
+  <tr>
+    <td>i_o_blur_{value}</td>
+    <td>Blur the image with respect to the value. Value can be an integer between 0 and 100. The args value to this modifier will specify the intensiveness of the blur operation.</td>
+  </tr>
+</table>
+
+!!! tip
+      The default behaviour of the blur image effect is to apply the blur function on the whole image. 
+
+!!! tip
+      Setting the selection window before blur operation will result in bluring only the selection window. 

docs/api-reference/compression.md

@@ -0,0 +1,43 @@
+---
+title: "Compression"
+---
+
+### JPEG Compression
+
+<table>
+  <tr>
+    <th>Command</th>
+    <th>Details</th>
+  </tr>
+  <tr>
+    <td>i_o_format_jpg_{ratio}</td>
+    <td>Compress image with JPEG comression. The ratio specify the compression ratio. Ratio is an integer between 0 and 100 where 0 is the most compression ratio whereas 100 is the best quality image.</td>
+  </tr>
+</table>
+
+### PNG Compression
+
+<table>
+  <tr>
+    <th>Command</th>
+    <th>Details</th>
+  </tr>
+  <tr>
+    <td>i_o_format_png</td>
+    <td>Compress and change the image format to PNG image format.</td>
+  </tr>
+</table>
+
+
+### WEBP Compression
+
+<table>
+  <tr>
+    <th>Command</th>
+    <th>Details</th>
+  </tr>
+  <tr>
+    <td>i_o_format_webp</td>
+    <td>Compress and change the image format to WEBP image format.</td>
+  </tr>
+</table>

docs/api-reference/crop.md

@@ -0,0 +1,20 @@
+---
+title: "Crop"
+---
+
+### Crop Operation
+
+<table>
+  <tr>
+    <th>Command</th>
+    <th>Details</th>
+  </tr>
+  <tr>
+    <td>i_o_crop</td>
+    <td>Crop the image according to the selection window.</td>
+  </tr>
+  <tr>
+    <td>i_o_rcrop</td>
+    <td>Crop the image according to the selection window while rounding the corners.</td>
+  </tr>
+</table>

docs/api-reference/flip.md

@@ -0,0 +1,24 @@
+---
+title: "Flip"
+---
+
+### Flip Operation
+
+<table>
+  <tr>
+    <th>Command</th>
+    <th>Details</th>
+  </tr>
+  <tr>
+    <td>i_o_flip_v</td>
+    <td>Flip the image vertically.</td>
+  </tr>
+  <tr>
+    <td>i_o_flip_h</td>
+    <td>Flip the image horizontally.</td>
+  </tr>
+  <tr>
+    <td>i_o_flip_b</td>
+    <td>Flip the image  both horizontally and vertically.</td>
+  </tr>
+</table>

docs/api-reference/gray-scale.md

@@ -0,0 +1,24 @@
+---
+title: "Gray Scale"
+---
+
+### Grayscale Operation
+
+<table>
+  <tr>
+    <th>Command</th>
+    <th>Details</th>
+  </tr>
+  <tr>
+    <td>i_o_gray</td>
+    <td>Make the image grayscale.</td>
+  </tr>
+</table>
+
+
+???+ tip
+      The default behaviour of the grayscale image effect is to apply the grayscale function on the whole image. 
+
+
+???+ tip
+      Setting the selection window before grayscale operation will result in applying the grayscale effect only on the selection window.