oarepo-ui 6.0.0.dev22__tar.gz

oarepo_ui-6.0.0.dev22/.gitignore

@@ -0,0 +1,384 @@
+#
+# Python gitignore
+#
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+coverage.json
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.mypy.ini
+.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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff.toml
+.ruff_cache/
+.mypy.ini
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# UV package management
+uv.lock
+
+#
+# Node.js gitignore
+#
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.*
+!.env.example
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Sveltekit cache directory
+.svelte-kit/
+
+# vitepress build output
+**/.vitepress/dist
+
+# vitepress cache directory
+**/.vitepress/cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# Firebase cache directory
+.firebase/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v3
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Vite logs files
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
+
+#
+# OARepo specific gitignore
+#
+.runner.sh
+.env-services
+.eslintrc.yaml
+.mypy.ini
+.ruff.toml
+
+#
+# Editors
+.vscode/
+.idea/
+*.swp
+*.swo
+*.swn
+*.sublime-workspace
+*.sublime-project
+*.kate-swp
+*.kate-swp.*
+*.komodoproject
+*.komodotools
+*.komodoide
+*.komodotools
+*.komodotools.*
+.DS_Store
+*.DS_Store?
+#
+
+.invenio.private

oarepo_ui-6.0.0.dev22/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: oarepo-ui
+Version: 6.0.0.dev22
+Summary: UI module for invenio 3.5+
+Project-URL: Homepage, https://github.com/oarepo/oarepo-ui
+License-Expression: MIT
+Requires-Python: <3.15,>=3.13
+Requires-Dist: deepmerge>=2.0
+Requires-Dist: frozendict
+Requires-Dist: jinja2-simple-tags
+Requires-Dist: jinjax<1.0.0,>=0.60
+Requires-Dist: oarepo-runtime<3.0.0,>=2.0.0dev0
+Requires-Dist: oarepo-theme<2.0.0,>=1.0.0dev1
+Requires-Dist: oarepo[rdm,tests]<15,>=14
+Requires-Dist: python-dotenv>=1.1.1
+Provides-Extra: dev
+Requires-Dist: oarepo-invenio-typing-stubs; extra == 'dev'
+Requires-Dist: pytest>=7.1.2; extra == 'dev'
+Provides-Extra: oarepo14
+Requires-Dist: oarepo<15.0.0,>=14.0.0; extra == 'oarepo14'
+Provides-Extra: tests
+Requires-Dist: oarepo-model>=0.1.0.dev16; extra == 'tests'
+Requires-Dist: oarepo-rdm>=1.0.0dev11; extra == 'tests'
+Requires-Dist: pytest-oarepo<3.0.0,>=2.0.0; extra == 'tests'
+Requires-Dist: pytest>=7.1.2; extra == 'tests'
+Provides-Extra: workflows
+Requires-Dist: oarepo-workflows; extra == 'workflows'
+Description-Content-Type: text/markdown
+
+<!--
+ Copyright (c) 2022 CESNET
+
+ This software is released under the MIT License.
+ https://opensource.org/licenses/MIT
+-->
+
+# OARepo UI
+
+This package provides implementation of base UI components for use in dynamic (React JS) & static (Jinja) pages and
+functions to render layouts from model configuration.
+
+## Usage
+
+### JinjaX
+
+See also [JinjaX documentation](https://jinjax.scaletti.dev/).
+
+Oarepo builds its static UI pages on top of the JinjaX library.
+To load a Jinja application, a JinjaX component is expected on the input. 
+The relative path to the component is taken from the configuration
+
+Components by default accept record metadata, ui definition and layout definition as parameters.
+To work with parameters within components, you need to define them in the template in the way described in the JinjaX documentation.
+
+### Examples
+
+Example of component specification in config:
+
+```python
+templates = {
+        "detail": "DetailPage",
+        "search": "SearchPage"
+    }
+```
+
+Example of possible contents of the DetailPage component, contained inside `templates/DetailPage.jinja`
+
+```json
+{#def metadata, ui, layout #}
+{% extends "oarepo_ui/detail.html" %}
+
+{%- block head_links %}
+
+{{ super() }}
+{{ webpack['docs_app_components.js']}}
+{{ webpack['docs_app_components.css']}}
+
+{%- endblock %}
+
+{% block record_main_content %}
+    <Main metadata={{metadata}}></Main>
+{% endblock %}
+
+{% block record_sidebar %}
+    <Sidebar metadata={{metadata}}></Sidebar>
+{% endblock %}
+```
+
+
+Sample of possible contents of Main component:
+```json
+{#def metadata, ui, layout #}
+<h1 style="margin-bottom: 1em">{{ metadata.title }}</h1>
+<dl class="ui very basic table">
+<Field label="accessibility">{{metadata.accessibility}}</Field>
+
+```
+
+You can also namespace your ui components, by using dot notation:
+
+```python
+templates = {
+        "detail": "myrepo.DetailPage",
+        "search": "myrepo.SearchPage"
+    }
+```
+
+Then, the component will be loaded from the `templates/myrepo/DetailPage.jinja` file.
+
+
+#### JinjaX components
+
+Within the Oarepo-ui library, basic components are defined in the `templates` folder.
+
+### React
+
+To render a custom layout in a React app (e. g. records search result page), this package provides the `useLayout` hook and an entrypoint
+for bootstrapping [Search UI](https://github.com/inveniosoftware/invenio-search-ui) app. In your `search.html` template, you can use it like this:
+
+```jinja
+{%- extends config.BASE_TEMPLATE %}
+
+{%- block javascript %}
+    {{ super() }}
+    {# imports oarepo-ui JS libraries to be used on page #}
+    {{ webpack['oarepo_ui.js'] }}
+    {# boots Invenio-Search-UI based search app, with dynamic UI widgets provided by oarepo-ui #}
+    {{ webpack['oarepo_ui_search.js'] }}
+{%- endblock %}
+
+{# ... #}
+
+<div class="ui container">
+  {# provides a DOM root element for the Search UI to be mounted into #}
+  <div data-invenio-search-config='{{ search_app_oarepo_config(app_id="oarepo-search") | tojson }}'></div>
+</div>
+```
+
+Next you will need to register an app context processor named `search_app_oarepo_config` and register it
+to blueprint handling the `search.html` template route. In the context processor, you can provide your
+own layout configuration for different parts of UI to be used by `oarepo-ui` libs to generate user interface widgets.
+
+```python
+def create_blueprint(app):
+    """Blueprint for the routes and resources."""
+    blueprint = Blueprint(
+        "your-app",
+        __name__,
+        template_folder="templates",
+        static_folder="static",
+    )
+
+    blueprint.add_url_rule("/", view_func=search)
+    blueprint.app_context_processor(search_app_context)
+    return blueprint
+
+
+def search():
+    """Search template."""
+    return render_template('your-app/search.html')
+
+def search_app_context():
+    """Search app context processor."""
+    return {
+        "search_app_oarepo_config": partial(
+            search_app_config,
+            "OAREPO_SEARCH",
+            [], #current_app.config["OAREPO_FACETS"],1
+            current_app.config["OAREPO_SORT_OPTIONS"],
+            endpoint="/api/your-records",
+            headers={"Accept": "application/json"},
+            overrides={
+                "layoutOptions": {
+                    "listView": True,
+                    "gridView": False,
+                    "ResultsList": {
+                        "item": {
+                            "component": 'segment',
+                            "children": [{
+                                "component": "header",
+                                "dataField": "metadata.title"
+                            }]
+                        }
+                    }
+                }
+            }
+        )
+    }
+```
+
+In your `invenio.cfg`, customize the general search app settings:
+
+```python
+OAREPO_SEARCH = {
+    "facets": [],
+    "sort": ["bestmatch", "newest", "oldest", "version"],
+}
+
+OAREPO_SORT_OPTIONS = {
+    "bestmatch": dict(
+        title=_("Best match"),
+        fields=["_score"],  # search defaults to desc on `_score` field
+    ),
+    "newest": dict(
+        title=_("Newest"),
+        fields=["-created"],
+    ),
+    "oldest": dict(
+        title=_("Oldest"),
+        fields=["created"],
+    ),
+    "version": dict(
+        title=_("Version"),
+        fields=["-versions.index"],
+    ),
+    "updated-desc": dict(
+        title=_("Recently updated"),
+        fields=["-updated"],
+    ),
+    "updated-asc": dict(
+        title=_("Least recently updated"),
+        fields=["updated"],
+    ),
+}
+```