webifier 0.1.20__tar.gz → 1.0.2__tar.gz

webifier-1.0.2/.github/workflows/python-publish.yml

@@ -0,0 +1,49 @@
+name: Upload Python Package
+
+on:
+  push:
+    tags:
+      - "v*"
+  release:
+    types: [created]
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build twine
+
+      - name: Verify release tag
+        run: |
+          TAG="$(git describe --tags --exact-match)"
+          case "$TAG" in
+            v[0-9]*)
+              echo "Publishing $TAG"
+              ;;
+            *)
+              echo "Refusing to publish from non-release tag: $TAG"
+              exit 1
+              ;;
+          esac
+
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          python -m build --sdist --wheel
+          python -m twine check dist/*
+          python -m twine upload dist/*

webifier-1.0.2/.gitignore

@@ -0,0 +1,168 @@
+**/.DS_Store
+
+# Generated by hatch-vcs at build time
+webifier/_version.py
+
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,jupyternotebooks
+
+### JupyterNotebooks ###
+# gitignore template for Jupyter Notebooks
+# website: http://jupyter.org/
+
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Remove previous ipynb_checkpoints
+#   git rm -r .ipynb_checkpoints/
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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/
+.ruff_cache/
+pytestdebug.log
+
+# 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/
+doc/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+
+# IPython
+
+# pyenv
+.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
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+# .env
+.env/
+.venv/
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+pythonenv*
+
+# 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/
+
+# operating system-related files
+*.DS_Store #file properties cache/storage on macOS
+Thumbs.db #thumbnail cache on Windows
+
+# profiling data
+.prof
+
+
+# End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks

webifier-1.0.2/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: webifier
+Version: 1.0.2
+Summary: Cook up a fully functional static website from YAML and Markdown.
+Project-URL: Homepage, https://github.com/webifier/build
+Project-URL: Repository, https://github.com/webifier/build
+Project-URL: Issues, https://github.com/webifier/build/issues
+Author-email: Vahid Zehtab <contact@vahidz.com>, Ahmad Salimi <ahsa9978@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: jinja2,jupyter notebook,markdown,static site,webifier
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4
+Requires-Dist: jinja2<3.2,>=3.0
+Requires-Dist: markdown
+Requires-Dist: pygments
+Requires-Dist: pyyaml
+Requires-Dist: webifier-extensions>=1.0.4
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Webifier
+
+[![Docs](https://img.shields.io/badge/docs-webifier.github.io-blue)](https://webifier.github.io/)
+[![PyPI](https://img.shields.io/pypi/v/webifier.svg)](https://pypi.org/project/webifier/)
+[![Python Package](https://github.com/webifier/build/actions/workflows/python-publish.yml/badge.svg)](https://github.com/webifier/build/actions/workflows/python-publish.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Webifier turns YAML, Markdown, HTML, notebooks, and other static content into a
+static website. It is meant to remove the publishing overhead from personal
+projects, research notes, notebooks, reports, and evolving documentation: decide
+what content goes where, commit it, and let Webifier build a navigable site.
+
+The core package stays small: config loading, page discovery, rendering,
+extension loading, hooks, template resolution, and asset copying. First-party
+renderers, templates, themes, search, comments, notebooks, and resume sections
+ship as the `webifier-extensions` package, which is installed automatically with
+`webifier`.
+
+## Install
+
+```shell
+pip install webifier
+```
+
+Documentation and examples live at [webifier.github.io](https://webifier.github.io/).
+
+## Build Locally
+
+```shell
+webify --index index.yml --output webified
+```
+
+For project pages, pass a base URL:
+
+```shell
+webify --baseurl my-repo --index index.yml --output webified
+```
+
+For a root domain or `<user>.github.io` site, use an empty base URL:
+
+```shell
+webify --baseurl "" --index index.yml --output webified
+```
+
+## Configure Extensions
+
+Extensions are enabled explicitly in your site config. The instance name is local
+to your site, and `uses` points to the installed extension implementation.
+
+```yaml
+config:
+  webifier:
+    extensions:
+      site:
+        uses: webifier.standard
+      markdown:
+        uses: webifier.markdown
+      notebooks:
+        uses: webifier.notebook
+      search:
+        uses: webifier.search
+      theme:
+        uses: webifier.theme
+        default: system
+      comments:
+        uses: webifier.comments
+```
+
+Extensions can register renderers, content renderers, templates, themes, assets,
+resolvers, format loaders, hooks, and config defaults. Page-aware hooks can
+inspect page config and page content before injecting assets into the head,
+navigation, footer, or other extension areas.
+
+## GitHub Action
+
+```yaml
+name: Webify
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: webifier/build@v1.0.1
+        with:
+          baseurl: ""
+          index: index.yml
+          publish_dir: webified
+```
+
+Deploy `webified/` with your preferred static hosting or GitHub Pages action.
+
+## License
+
+MIT License.

webifier-1.0.2/README.md

@@ -0,0 +1,98 @@
+# Webifier
+
+[![Docs](https://img.shields.io/badge/docs-webifier.github.io-blue)](https://webifier.github.io/)
+[![PyPI](https://img.shields.io/pypi/v/webifier.svg)](https://pypi.org/project/webifier/)
+[![Python Package](https://github.com/webifier/build/actions/workflows/python-publish.yml/badge.svg)](https://github.com/webifier/build/actions/workflows/python-publish.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Webifier turns YAML, Markdown, HTML, notebooks, and other static content into a
+static website. It is meant to remove the publishing overhead from personal
+projects, research notes, notebooks, reports, and evolving documentation: decide
+what content goes where, commit it, and let Webifier build a navigable site.
+
+The core package stays small: config loading, page discovery, rendering,
+extension loading, hooks, template resolution, and asset copying. First-party
+renderers, templates, themes, search, comments, notebooks, and resume sections
+ship as the `webifier-extensions` package, which is installed automatically with
+`webifier`.
+
+## Install
+
+```shell
+pip install webifier
+```
+
+Documentation and examples live at [webifier.github.io](https://webifier.github.io/).
+
+## Build Locally
+
+```shell
+webify --index index.yml --output webified
+```
+
+For project pages, pass a base URL:
+
+```shell
+webify --baseurl my-repo --index index.yml --output webified
+```
+
+For a root domain or `<user>.github.io` site, use an empty base URL:
+
+```shell
+webify --baseurl "" --index index.yml --output webified
+```
+
+## Configure Extensions
+
+Extensions are enabled explicitly in your site config. The instance name is local
+to your site, and `uses` points to the installed extension implementation.
+
+```yaml
+config:
+  webifier:
+    extensions:
+      site:
+        uses: webifier.standard
+      markdown:
+        uses: webifier.markdown
+      notebooks:
+        uses: webifier.notebook
+      search:
+        uses: webifier.search
+      theme:
+        uses: webifier.theme
+        default: system
+      comments:
+        uses: webifier.comments
+```
+
+Extensions can register renderers, content renderers, templates, themes, assets,
+resolvers, format loaders, hooks, and config defaults. Page-aware hooks can
+inspect page config and page content before injecting assets into the head,
+navigation, footer, or other extension areas.
+
+## GitHub Action
+
+```yaml
+name: Webify
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: webifier/build@v1.0.1
+        with:
+          baseurl: ""
+          index: index.yml
+          publish_dir: webified
+```
+
+Deploy `webified/` with your preferred static hosting or GitHub Pages action.
+
+## License
+
+MIT License.

webifier-1.0.2/action.yml

@@ -0,0 +1,46 @@
+name: 'Webifier Build'
+description: 'GitHub Action to build a static website and deploy on github pages'
+author: 'webifier'
+branding:
+  color: 'blue'
+  icon: 'cloud'
+
+inputs:
+  repo:
+    description: 'GitHub repository of website material (default: $GITHUB_REPOSITORY)'
+    default: ${{ github.repository }}
+    required: false
+  baseurl:
+    description: >
+      Base URL (slug) of website (default: name of repository). You should set this field to "" if you are using
+      Webifier for building a github.io repository itself (in a `<username/organization>.github.io` repository ).
+    default: ${{ github.event.repository.name }}
+    required: false
+  index:
+    description: >
+      Entry index file (default: index.yml) change this if your entry index file is not named "index.yml" or is not
+      located in the root of your repository.
+    default: 'index.yml'
+    required: false
+  templates_dir:
+    description: >
+      Base directory to lookup custom jinja2 templates in (default: ".").
+    default: "."
+    required: false
+  publish_dir:
+    description: >
+      Where should the webified results end up (default: "./webified/")
+    default: "./webified/"
+    required: false
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    - run: python -m pip install --upgrade pip
+      shell: bash
+    - run: python -m pip install --upgrade webifier webifier-extensions
+      shell: bash
+    - run: webify --repo-full-name "${{ inputs.repo }}" --baseurl "${{ inputs.baseurl }}" --index ${{ inputs.index }} --output="${{ inputs.publish_dir }}" --templates-dir="${{ inputs.templates_dir }}"
+      shell: bash

webifier-1.0.2/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "webifier"
+dynamic = ["version"]
+description = "Cook up a fully functional static website from YAML and Markdown."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "Vahid Zehtab", email = "contact@vahidz.com" },
+    { name = "Ahmad Salimi", email = "ahsa9978@gmail.com" },
+]
+keywords = ["webifier", "jupyter notebook", "markdown", "jinja2", "static site"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "beautifulsoup4",
+    "jinja2>=3.0,<3.2",
+    "markdown",
+    "pygments",
+    "pyyaml",
+    "webifier-extensions>=1.0.4",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "ruff",
+]
+
+[project.scripts]
+webify = "webifier.interface.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/webifier/build"
+Repository = "https://github.com/webifier/build"
+Issues = "https://github.com/webifier/build/issues"
+
+# --- Version: single source of truth from git tags ---
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.version.raw-options]
+version_scheme = "no-guess-dev"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "webifier/_version.py"
+
+# --- Include non-Python assets in the wheel ---
+[tool.hatch.build.targets.wheel]
+packages = ["webifier"]
+
+[tool.hatch.build.targets.wheel.force-include]
+# Covered by package discovery, but explicit for clarity:
+# all assets (templates, css, images) under webifier/ are included
+
+# --- Ruff (replaces flake8 + isort + black) ---
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["webifier"]
+
+# --- Pytest ---
+[tool.pytest.ini_options]
+testpaths = ["tests"]