diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index fbc73ae0e..0f6ff5632 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -15,8 +15,9 @@ "GitHub.copilot-chat", "github.vscode-github-actions", "ms-python.python", + "usernamehw.errorlens", + "charliermarsh.ruff", "ms-toolsai.jupyter", - "ms-python.vscode-pylance", "eamodio.gitlens", "tilt-dev.tiltfile", "Vue.volar", @@ -27,6 +28,7 @@ "settings": { "python.testing.pytestEnabled": true, "python.testing.cwd": "${workspaceFolder}/tests", + "python.envFile": "${workspaceFolder}/extralit/.env.test", "python.testing.pytestArgs": [ "-vs", "--disable-warnings" ], "python.defaultInterpreterPath": "/opt/conda/bin/python", "python.condaPath": "/usr/local/bin/micromamba", @@ -95,7 +97,7 @@ "ghcr.io/mamba-org/devcontainer-features/micromamba": { "autoActivate": true, "channels": "conda-forge huggingface defaults", - "packages": "python==3.10.14 uvicorn uv pdm ipykernel pre-commit pyparsing!=3.0.5 pytest pytest-cov pytest-mock pytest-asyncio==0.21.1 pytest-env factory_boy~=3.2.1 pandoc==2.12 ipython<8.0.0 nodejs=18.16.1 pandoc==2.12 pytest-randomly>=3.15.0", + "packages": "python==3.10.14 uvicorn uv pdm ipykernel pre-commit pyparsing!=3.0.5 pytest pytest-cov pytest-mock pytest-asyncio==0.21.1 pytest-env factory_boy~=3.2.1 pandoc==2.12 ipython<8.0.0 nodejs==18.16.1 pandoc==2.12 pytest-randomly>=3.15.0", "envFile": "", "envName": "base" }, diff --git a/.devcontainer/docker-compose/devcontainer.json b/.devcontainer/docker-compose/devcontainer.json index 2307ab056..bf43e27aa 100644 --- a/.devcontainer/docker-compose/devcontainer.json +++ b/.devcontainer/docker-compose/devcontainer.json @@ -86,7 +86,8 @@ "GitHub.copilot", "GitHub.copilot-chat", "ms-python.python", - "ms-python.vscode-pylance", + "usernamehw.errorlens", + "charliermarsh.ruff", "eamodio.gitlens", "tilt-dev.tiltfile", "github.vscode-github-actions", @@ -97,21 +98,21 @@ }, "settings": { "python.testing.pytestEnabled": true, - "python.testing.cwd": "${workspaceFolder}/argilla/", + "python.testing.cwd": "${workspaceFolder}/extralit/", "python.testing.pytestArgs": [ "-vv", - "--disable-warnings", - "--cov", - "--cov-report=xml:coverage.xml", + "--disable-warnings" ], "python.defaultInterpreterPath": "/opt/conda/bin/python", "python.condaPath": "/usr/local/bin/micromamba", + "python.envFile": "${workspaceFolder}/extralit/.env.test", "search.exclude": { "argilla-server/src/argilla_server/static/": true, "argilla-frontend/dist/": true, "_nuxt/": true, "node_modules/": true, - ".venv/": true + ".venv/": true, + "**/*.png": true }, "files.watcherExclude": { "argilla-server/src/argilla_server/static/": true, diff --git a/.devcontainer/docker-compose/docker-compose.yml b/.devcontainer/docker-compose/docker-compose.yml index 122916b2a..84598a686 100644 --- a/.devcontainer/docker-compose/docker-compose.yml +++ b/.devcontainer/docker-compose/docker-compose.yml @@ -2,23 +2,23 @@ version: '3.8' services: devcontainer: - build: + build: context: . dockerfile: Dockerfile env_file: - .env.dev volumes: - - ../../..:/workspaces:cached + - ../../..:/workspaces:cached command: ["sh", "-c", "trap 'exit 0' SIGTERM; while :; do sleep 1; done"] depends_on: - elasticsearch - postgres - minio - - redis + - redis network_mode: host - + elasticsearch: - image: docker.elastic.co/elasticsearch/elasticsearch:8.15.0 + image: docker.elastic.co/elasticsearch/elasticsearch:8.17.0 ports: - "9200:9200" - "9300:9300" @@ -30,7 +30,6 @@ services: xpack.security.http.ssl.enabled: false ES_JAVA_OPTS: -Xms512m -Xmx512m bootstrap.memory_lock: false - network_mode: host healthcheck: test: ["CMD-SHELL", "curl -f http://localhost:9200/_cluster/health || exit 1"] interval: 30s @@ -88,7 +87,7 @@ services: retries: 3 restart: unless-stopped - redis: + redis: image: redis:7.0 container_name: extralit-redis ports: diff --git a/.devcontainer/docker-compose/environment.yml b/.devcontainer/docker-compose/environment.yml index 516b25bf4..245208eb4 100644 --- a/.devcontainer/docker-compose/environment.yml +++ b/.devcontainer/docker-compose/environment.yml @@ -5,7 +5,7 @@ channels: - huggingface - defaults dependencies: - - python~=3.9.7 + - python~=3.12 - pip>=2.22.0 - pdm # pyparsing 3.0.5 seems to be buggy @@ -17,7 +17,6 @@ dependencies: - pytest-asyncio==0.21.1 # Pinning version 0.21.1, version 0.23.2 is causing problems with GitHub workflows - pytest-env - factory_boy~=3.2.1 - # docs, pandoc needs conda ... - pandoc==2.12 # we need this to ensure syntax highlighting in the notebook code cells for the docs - ipython<8.0.0 diff --git a/.devcontainer/docker-compose/setup.sh b/.devcontainer/docker-compose/setup.sh index ec15540d0..37111575c 100644 --- a/.devcontainer/docker-compose/setup.sh +++ b/.devcontainer/docker-compose/setup.sh @@ -3,9 +3,11 @@ # Perform the pip editable install if ! pip list | grep -q "extralit"; then echo "Installing required packages and editable installs..." + pdm config use_uv true + pdm config python.install_root /opt/conda/ uv pip install -q "sentence-transformers<3.0.0" transformers "textdescriptives<3.0.0" \ -e /workspaces/extralit/argilla-server/ && \ - uv pip install -q -e /workspaces/extralit/argilla/ + uv pip install -q -e /workspaces/extralit/extralit/ else echo "Package 'extralit' is already installed. Skipping installation." fi diff --git a/.devcontainer/setup.sh b/.devcontainer/setup.sh index 913170359..c54b8ea65 100644 --- a/.devcontainer/setup.sh +++ b/.devcontainer/setup.sh @@ -16,8 +16,10 @@ fi # Perform the pip editable install if ! pip list | grep -q "extralit"; then echo 'Installing required packages and editable installs...' + pdm config use_uv true + pdm config python.install_root /opt/conda/ uv pip install -e /workspaces/extralit/argilla-server/ - uv pip install -e /workspaces/extralit/argilla/ + uv pip install -e /workspaces/extralit/extralit/ else echo 'Package 'extralit' is already installed. Skipping installation.' fi diff --git a/.devcontainer/ui-design/devcontainer.json b/.devcontainer/ui-design/devcontainer.json index 4446d37bf..af3b2e8f2 100644 --- a/.devcontainer/ui-design/devcontainer.json +++ b/.devcontainer/ui-design/devcontainer.json @@ -11,7 +11,10 @@ "mrmlnc.vscode-scss", "sibiraj-s.vscode-scss-formatter", "esbenp.prettier-vscode", - "ms-vscode.live-server" + "ms-vscode.live-server", + "usernamehw.errorlens", + "charliermarsh.ruff", + "firsttris.vscode-jest-runner" ], "settings": { "workbench.colorTheme": "Default Light+", diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 4a40b6ed0..07e20e5a0 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -5,58 +5,42 @@ # opens a pull request that modifies code in different parts of the repository. # The last matching pattern takes precedence. -# Default owners for everything (fallback) -* @extralit/core-team -/argilla/**/* @extralit/contributors -/argilla-server/**/* @extralit/contributors -/argilla-v1/**/* @extralit/contributors - -# Python SDK (general files) -/argilla/*.py @extralit/sdk -/argilla/pyproject.toml @extralit/sdk -/argilla/pdm.lock @extralit/sdk - -# Python SDK (source and tests) -/argilla/src/**/* @extralit/sdk -/argilla/tests/**/* @extralit/sdk +# SDK and Core Extraction +/extralit/* @extralit/sdk +/extralit/src/**/* @extralit/sdk +/extralit/tests/**/* @extralit/sdk +/extralit/pyproject.toml @extralit/sdk +/extralit/pdm.lock @extralit/sdk # Backend Server -/argilla-server/**/* @extralit/backend +/extralit-server/**/* @extralit/backend # Frontend -/argilla-frontend/**/* @extralit/frontend +/extralit-frontend/**/* @extralit/frontend # Legacy compatibility layer -/argilla-v1/**/* @extralit/sdk @extralit/backend - -# AI/ML-specific code (more specific paths take precedence) -/argilla/src/extralit/extraction/**/* @extralit/ai -/argilla/src/extralit/extraction/**/* @extralit/ai -/argilla/src/extralit/metrics/**/* @extralit/ai -/argilla/src/extralit/preprocessing/**/* @extralit/ai -/argilla/src/extralit/schema/**/* @extralit/ai - -# AI services -/argilla/src/extralit/pipeline/**/* @extralit/ai @extralit/backend -/argilla/src/extralit/server/**/* @extralit/ai @extralit/backend -/argilla/src/extralit/storage/**/* @extralit/ai @extralit/backend - -# Core infrastructure and configuration files -/.github/workflows/**/* @extralit/infra -/.github/ @extralit/infra -/.devcontainer/ @extralit/infra -/docker/ @extralit/infra +/extralit-v1/**/* @extralit/sdk @extralit/backend + +# AI/ML-specific code +/extralit/src/extralit/{extraction,metrics,preprocessing,schema}/**/* @extralit/ai +/extralit/src/extralit/pipeline/**/* @extralit/ai @extralit/backend +/extralit/src/extralit/server/**/* @extralit/ai @extralit/backend +/extralit/src/extralit/storage/**/* @extralit/ai @extralit/backend + +# Infrastructure and configuration +/.github/** @extralit/infra +/.devcontainer/** @extralit/infra +/docker/** @extralit/infra *.Dockerfile @extralit/infra Tiltfile @extralit/infra codecov.yml @extralit/infra # Documentation *.md @extralit/docs -/argilla/docs/**/* @extralit/docs +/extralit/docs/**/* @extralit/docs /examples/**/* @extralit/docs @extralit/sdk - -# Security and legal files +# Security and legal /.github/CODEOWNERS @extralit/core-team /SECURITY.md @extralit/core-team /LICENSE @extralit/core-team diff --git a/.github/ISSUE_TEMPLATE/bug-python-deployment.yml b/.github/ISSUE_TEMPLATE/bug-python-deployment.yml index 43d72938c..f6a8cd8fd 100644 --- a/.github/ISSUE_TEMPLATE/bug-python-deployment.yml +++ b/.github/ISSUE_TEMPLATE/bug-python-deployment.yml @@ -20,7 +20,6 @@ body: validations: required: true - - type: textarea id: code attributes: @@ -34,16 +33,9 @@ body: ```bash # Your bash commands or stacktrace here ``` - render: python validations: required: true - # - type: markdown - # attributes: - # value: | - # ## Environment - # Since version 1.16.0 you can use `python -m argilla info` command to easily get the used versions. - - type: input id: extralit-version attributes: @@ -82,12 +74,12 @@ body: label: Python Version description: What version of Python are you using? options: - - 3.7 - - 3.8 - - 3.9 - - 3.10 - - 3.11 - - 3.12 + - "3.7" + - "3.8" + - "3.9" + - "3.10" + - "3.11" + - "3.12" - Other (specify in additional context) validations: required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 1055753f5..c2f36646e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -72,4 +72,4 @@ body: - Other multiple: true validations: - required: false \ No newline at end of file + required: false diff --git a/.github/ISSUE_TEMPLATE/refactor.yml b/.github/ISSUE_TEMPLATE/refactor.yml index e30b17cb3..483d70d8c 100644 --- a/.github/ISSUE_TEMPLATE/refactor.yml +++ b/.github/ISSUE_TEMPLATE/refactor.yml @@ -1,4 +1,4 @@ -name: "Refactor Request" +name: "🛠️ Refactor Request" description: "Suggest a code refactor to improve maintainability, readability, or performance." title: "[Refactor] " labels: ["refactor"] diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 76b81d17a..9275fb185 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -160,7 +160,6 @@ When contributing to Extralit, consider these guidelines: - Keep database models focused on structure, not behavior - Use validators for input validation 4. **Write tests**: Add tests for new functionality in the appropriate test directories -5. **Document your changes**: Update documentation when adding or changing features ## Common Development Tasks @@ -185,4 +184,3 @@ When contributing to Extralit, consider these guidelines: 2. Create or update components in `components/features/` 3. Connect to the backend using services in `v1/infrastructure/services/` 4. Add tests for the new functionality - diff --git a/.github/workflows/README.md b/.github/workflows/README.md new file mode 100644 index 000000000..b5373d3a8 --- /dev/null +++ b/.github/workflows/README.md @@ -0,0 +1,86 @@ +# GitHub Actions Workflows + +This directory contains GitHub Actions workflows for building, testing, and deploying the Extralit project. The workflows are designed to run on various events, such as pushes to specific branches, pull requests, and manual triggers. + +## Key Workflows + +### `extralit.yml` + +Builds and publishes the `extralit` SDK Python package. + +- **Trigger**: Push to main/develop/releases branches, pull requests, or manual dispatch +- **Python versions**: 3.9, 3.10, 3.11, 3.12, 3.13 +- **Key steps**: + - Build and test the package + - Upload test coverage to Codecov + - Publish to PyPI + +#### Python 3.13 Compatibility + +Python 3.13 support requires special handling due to some dependencies not yet being fully compatible: + +- The `spacy` dependency is specified with version conditions based on the Python version (v3.8.0+ for Python 3.13) +- These conditional dependencies ensure the package can be built and tested on Python 3.13 + +### `argilla-server.yml` + +Builds and publishes the `argilla-server` package. + +- **Trigger**: Push to main/develop/releases branches, pull requests, or manual dispatch +- **Key steps**: + - Run Elasticsearch, PostgreSQL, Redis, and MinIO services + - Build and test the server package + - Build Docker images + - Publish to PyPI +- **Frontend integration**: Includes steps to build the frontend and incorporate it into the server package + +## Caching Strategy + +The workflows use multiple caching strategies to improve build performance: + +1. **PDM cache**: Through the `setup-pdm` action +2. **UV cache**: Through the `actions/cache` action + - Key format: `{os}-uv-{python-version}-{pdm_hash}` for argilla + - Key format: `{os}-uv-server-{pdm_hash}` for argilla-server + - Paths cached: `~/.cache/uv`, `~/.cache/pip` + +The UV cache uses the PDM lockfile hash to ensure the cache is invalidated when dependencies change. This approach provides more precise cache invalidation than date-based keys. + +## Environment Variables + +The workflows set various environment variables: + +- `UV_CACHE_DIR`: Location of the UV cache +- `UV_NO_WAIT`: Prevent UV from waiting for operations to complete (improves CI performance) +- `UV_SYSTEM_PYTHON`: Use the system Python instead of a virtual environment +- `PDM_IGNORE_ACTIVE_VENV`: Ignore active virtual environments + +Additional environment variables are set in specific workflows: +- For `argilla-server.yml`: Database connection variables for Postgres, Elasticsearch, Redis, and MinIO +- For `extralit.yml`: HuggingFace credentials for integration tests + +## Common Issues & Solutions + +### Package caching not working + +If dependencies are still being downloaded despite cache hits: + +1. Ensure `pdm.lock` is up-to-date with `pyproject.toml` (run `pdm lock --no-sync`) +2. Make sure the `pdm.lock` file is committed to the repository (not gitignored) +3. Check that the cache key properly includes the lockfile hash +4. Verify that both directories (`~/.cache/uv` and `~/.cache/pip`) are being cached + +### Incompatible dependencies + +For Python 3.13 or newer Python versions: + +1. Use conditional dependencies in `pyproject.toml` with version specifiers +2. Add special handling in workflows for these Python versions +3. Skip tests that depend on incompatible packages + +## Best Practices + +1. Always commit the `pdm.lock` file to ensure reproducible builds +2. Use conditional dependencies for Python version compatibility +3. Use caching effectively with proper invalidation strategies +4. Set up proper test coverage reporting \ No newline at end of file diff --git a/.github/workflows/argilla-frontend.deploy-environment.yml b/.github/workflows/argilla-frontend.deploy-environment.yml index 34aecac03..9bcf22ee2 100644 --- a/.github/workflows/argilla-frontend.deploy-environment.yml +++ b/.github/workflows/argilla-frontend.deploy-environment.yml @@ -6,7 +6,7 @@ on: image-name: description: The name of the Docker image to deploy. type: string - default: argilla/argilla-quickstart-for-dev + default: extralit/argilla-quickstart-for-dev image-version: description: The version of the Docker image to deploy. In the form pr-. type: string diff --git a/.github/workflows/argilla-frontend.yml b/.github/workflows/argilla-frontend.yml index c1019368f..69770f90c 100644 --- a/.github/workflows/argilla-frontend.yml +++ b/.github/workflows/argilla-frontend.yml @@ -10,7 +10,7 @@ on: pull_request: paths: - "argilla-frontend/**" - + types: - opened - edited @@ -43,7 +43,7 @@ jobs: excluded_globs: "*.spec.js;**/*.{png,jpg,svg,md};**/!(*.module).ts,**/__pycache__/,**/__mocks__/,LICENSE*,**/.gitignore,**/*.egg-info/,**/.*/" output_file: "repo-visualizer.svg" should_push: false - + - name: Upload repo visualizer diagram as artifact uses: actions/upload-artifact@v4 with: @@ -65,15 +65,24 @@ jobs: run: | npm run lint - - name: Run tests 🧪 + - name: Run tests with coverage 🧪 + id: run-tests continue-on-error: true run: | - npm run test + npm run test:coverage + + - name: Upload frontend test coverage + if: always() + uses: codecov/codecov-action@v5.4.3 + with: + files: ./coverage/lcov.info + flags: frontend + token: ${{ secrets.CODECOV_TOKEN }} + fail_ci_if_error: false - name: Build package 📦 env: # BASE_URL is used in the server to support parameterizable base root path - # See scripts/build_frontend.sh BASE_URL: "@@baseUrl@@" DIST_FOLDER: ./dist run: | @@ -86,7 +95,7 @@ jobs: path: argilla-frontend/dist build_dev_docker_image: - name: Build development argilla-fronted docker image + name: Build development argilla-frontend docker image needs: build uses: ./.github/workflows/argilla-frontend.build-push-dev-frontend-docker.yml if: | @@ -96,8 +105,6 @@ jobs: image-name: extralit/argilla-frontend-for-dev dockerfile: argilla-frontend/dev.frontend.Dockerfile platforms: linux/amd64 - build-args: | - ARGILLA_SERVER_TAG=main secrets: inherit # deploy: diff --git a/.github/workflows/argilla-server.yml b/.github/workflows/argilla-server.yml index 458161593..86295cb97 100644 --- a/.github/workflows/argilla-server.yml +++ b/.github/workflows/argilla-server.yml @@ -15,7 +15,7 @@ on: paths: - "argilla-server/**" - ".github/workflows/argilla-server.*" - + pull_request: paths: - "argilla-server/**" @@ -35,7 +35,7 @@ jobs: services: elasticsearch: - image: docker.elastic.co/elasticsearch/elasticsearch:8.15.0 + image: docker.elastic.co/elasticsearch/elasticsearch:8.17.0 ports: - 9200:9200 env: @@ -88,31 +88,46 @@ jobs: - name: Checkout Code 🛎 uses: actions/checkout@v4 - - name: Setup PDM - uses: pdm-project/setup-pdm@v4 + - name: Install uv + uses: astral-sh/setup-uv@v5 with: - python-version-file: argilla-server/pyproject.toml - cache-dependency-path: argilla-server/pdm.lock - cache: true + pyproject-file: "argilla-server/pyproject.toml" + enable-cache: true + cache-local-path: ~/.cache/uv + cache-dependency-glob: "argilla-server/pdm.lock" + + - name: Install PDM + run: uv tool install pdm - name: Install dependencies - run: pdm install + run: | + pdm config use_uv true + pdm config python.install_root "$(uv python dir)" + pdm install --dev - name: Run tests 📈 + id: run-tests continue-on-error: true + env: + HF_TOKEN_ARGILLA_INTERNAL_TESTING: ${{ secrets.HF_TOKEN_ARGILLA_INTERNAL_TESTING }} run: | ARGILLA_DATABASE_URL=postgresql://postgres:postgres@localhost:5432/argilla ARGILLA_ELASTICSEARCH=http://localhost:9200 ARGILLA_SEARCH_ENGINE=elasticsearch - pdm test tests/unit -vs --cov=argilla_server --cov-report=xml:coverage.xml --junitxml=junit.xml -o junit_family=legacy + pdm test-cov tests/unit - name: Upload test coverage - uses: codecov/codecov-action@v4 + if: always() + uses: codecov/codecov-action@v5.4.3 with: - file: coverage.xml + files: coverage.xml flags: argilla-server token: ${{ secrets.CODECOV_TOKEN }} - + + - name: Check test status + if: steps.run-tests.outcome == 'failure' + run: exit 1 + - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 @@ -155,11 +170,11 @@ jobs: || github.ref == 'refs/heads/develop' || contains(github.ref, 'releases/') || github.event_name == 'workflow_dispatch' - || (github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork) + || (github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork && !github.event.pull_request.draft) needs: - build with: - is_release: ${{ github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch' }} + is_release: ${{ github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch' }} publish_latest: ${{ github.ref == 'refs/heads/main' }} secrets: inherit @@ -167,7 +182,7 @@ jobs: publish_release: name: Publish Release runs-on: ubuntu-latest - if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch' }} + if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch' }} needs: - build @@ -196,7 +211,7 @@ jobs: excluded_globs: "*.spec.js;**/*.{png,jpg,svg,md};**/!(*.module).ts,**/__pycache__/,**/__mocks__/,LICENSE*,**/.gitignore,**/*.egg-info/,**/.*/" output_file: "repo-visualizer.svg" should_push: false - + - name: Upload repo visualizer diagram as artifact uses: actions/upload-artifact@v4 with: diff --git a/.github/workflows/argilla-v1.yml b/.github/workflows/argilla-v1.yml index 46bac55c4..213684103 100644 --- a/.github/workflows/argilla-v1.yml +++ b/.github/workflows/argilla-v1.yml @@ -41,27 +41,9 @@ jobs: use-mamba: true activate-environment: argilla - - name: Get date for conda cache - id: get-date - run: echo "::set-output name=today::$(/bin/date -u '+%Y%m%d')" - shell: bash - - - name: Cache Conda env - uses: actions/cache@v3 - id: cache - with: - path: ${{ env.CONDA }}/envs - key: conda-${{ runner.os }}--${{ runner.arch }}--${{ steps.get-date.outputs.today }}-${{ hashFiles('argilla-v1/environment_dev.yml') }}-${{ env.CACHE_NUMBER }} - - name: Update environment - if: steps.cache.outputs.cache-hit != 'true' - run: mamba env update -n argilla -f environment_dev.yml - - - name: Cache pip 👜 - uses: actions/cache@v3 - with: - path: ~/.cache/pip - key: ${{ runner.os }}-pip-${{ env.CACHE_NUMBER }}-${{ hashFiles('pyproject.toml') }} + run: | + mamba env update -n argilla -f environment_dev.yml - name: Set huggingface hub credentials if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' || startsWith(github.ref, 'refs/heads/releases') @@ -72,19 +54,19 @@ jobs: - name: Run unit tests 📈 continue-on-error: true run: | - pip install -e ".[server,listeners]" + uv pip install -e ".[server,listeners]" pytest tests/unit -vs - name: Run tests with pandas v2 📈 continue-on-error: true run: | - pip install "pandas~=2.0" pytest-custom_exit_code + uv pip install "pandas~=2.0" pytest-custom_exit_code pytest --suppress-no-test-exit-code tests/unit -vs - name: Run tests with pydantic v2 📈 continue-on-error: true run: | - pip install "pydantic~=2.0" pytest-custom_exit_code + uv pip install "pydantic~=2.0" pytest-custom_exit_code pytest --suppress-no-test-exit-code tests/unit -vs - name: Build Package 🍟 diff --git a/.github/workflows/argilla.docs.yml b/.github/workflows/extralit.docs.yml similarity index 82% rename from .github/workflows/argilla.docs.yml rename to .github/workflows/extralit.docs.yml index cdfac5f61..43094f496 100644 --- a/.github/workflows/argilla.docs.yml +++ b/.github/workflows/extralit.docs.yml @@ -15,12 +15,13 @@ on: - "develop" - "docs/**" paths: - - "argilla/docs/**" - - "argilla/mkdocs.yml" + - ".github/workflows/extralit.docs.yml" + - "extralit/docs/**" + - "extralit/mkdocs.yml" defaults: run: - working-directory: argilla + working-directory: extralit permissions: contents: write @@ -41,17 +42,32 @@ jobs: - uses: actions/checkout@v4 - - name: Setup Python + - name: Install uv + uses: astral-sh/setup-uv@v5 + with: + pyproject-file: "extralit/pyproject.toml" + python-version: "3.10" + enable-cache: true + cache-local-path: ~/.cache/uv + ignore-nothing-to-cache: true + cache-dependency-glob: "extralit/pdm.lock" + + - name: Setup PDM uses: pdm-project/setup-pdm@v4 with: python-version: "3.10" cache: true cache-dependency-path: | - argilla/pdm.lock + extralit/pdm.lock - name: Install dependencies + env: + PDM_IGNORE_ACTIVE_VENV: 1 run: | + pdm config use_uv true + pdm config python.install_root "$(uv python dir)" pdm install -q + uv cache prune --ci - name: Set git credentials run: | diff --git a/.github/workflows/argilla.yml b/.github/workflows/extralit.yml similarity index 57% rename from .github/workflows/argilla.yml rename to .github/workflows/extralit.yml index 10c5420f6..47bcce6cb 100644 --- a/.github/workflows/argilla.yml +++ b/.github/workflows/extralit.yml @@ -1,4 +1,4 @@ -name: Build and publish the `argilla` sdk python package +name: Build Extralit Package & Publish concurrency: group: ${{ github.workflow }}-${{ github.sha }} @@ -13,12 +13,14 @@ on: - develop - releases/** paths: - - "argilla/**" + - "extralit/**" - ".github/workflows/argilla.*" + paths-ignore: + - "extralit/docs/**" pull_request: paths: - - "argilla/**" + - "extralit/**" - "argilla-server/**" permissions: @@ -29,7 +31,7 @@ jobs: build: services: argilla-server: - image: extralitdev/argilla-hf-spaces + image: extralitdev/argilla-hf-spaces:develop ports: - 6900:6900 env: @@ -38,40 +40,87 @@ jobs: USERNAME: argilla PASSWORD: 12345678 API_KEY: argilla.apikey - runs-on: ubuntu-latest + # Configure storage to use local files instead of MinIO + ARGILLA_S3_ENDPOINT: "" + ARGILLA_S3_ACCESS_KEY: "" + ARGILLA_S3_SECRET_KEY: "" + runs-on: ubuntu-22.04 defaults: run: - working-directory: argilla + working-directory: extralit strategy: fail-fast: true matrix: - python-version: ["3.9", "3.10", "3.11", "3.12"] + python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] steps: - uses: actions/checkout@v4 - - name: Setup PDM - uses: pdm-project/setup-pdm@v4 + - name: Install uv + uses: astral-sh/setup-uv@v5 with: + pyproject-file: "extralit/pyproject.toml" python-version: ${{ matrix.python-version }} - cache: true - cache-dependency-path: | - argilla/pdm.lock + enable-cache: true + cache-local-path: ~/.cache/uv + ignore-nothing-to-cache: true + cache-dependency-glob: "extralit/pdm.lock" + - name: Install PDM + run: uv tool install pdm - name: Install dependencies + env: + PDM_IGNORE_ACTIVE_VENV: 1 run: | + pdm config use_uv true + pdm config python.install_root "$(uv python dir)" + + # Special handling for Python 3.13 + if [[ "${{ matrix.python-version }}" == "3.13" ]]; then + uv pip install --only-binary=:all: spacy thinc pyarrow + fi + pdm install + uv cache prune --ci - name: Wait for argilla server to start run: | while ! curl -XGET http://localhost:6900/api/_status; do sleep 5; done + # Create a directory for local storage that the container can access + mkdir -p /tmp/argilla-files + chmod -R 777 /tmp/argilla-files - name: Set huggingface hub credentials run: | echo "HF_TOKEN_ARGILLA_INTERNAL_TESTING=${{ secrets.HF_TOKEN_ARGILLA_INTERNAL_TESTING }}" >> "$GITHUB_ENV" echo "Enable HF access token" - name: Run unit tests + id: tests-unit + continue-on-error: true run: | - pdm run test tests/unit + pdm run test-cov tests/unit + - name: Run integration tests + id: tests-integration + continue-on-error: true + run: | + pdm run test-cov tests/integration + + - name: Generate coverage report + if: always() continue-on-error: true run: | - pdm run test tests/integration + pdm run coverage xml -o coverage.xml + pdm run coverage report + + - name: Upload test coverage + if: always() + uses: codecov/codecov-action@v5.4.3 + with: + files: coverage.xml + flags: argilla + token: ${{ secrets.CODECOV_TOKEN }} + fail_ci_if_error: false + + - name: Check test status + if: steps.tests-unit.outcome == 'failure' || steps.tests-integration.outcome == 'failure' + run: exit 1 + - name: Build package run: | pdm build @@ -80,14 +129,14 @@ jobs: # Upload the package to be used in the next jobs only once if: ${{ matrix.python-version == '3.9' }} with: - name: argilla - path: argilla/dist + name: extralit + path: extralit/dist # This job will publish argilla package into PyPI repository publish_release: name: Publish Release runs-on: ubuntu-latest - if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch' }} + if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch' }} permissions: # This permission is needed for private repositories. @@ -101,7 +150,7 @@ jobs: defaults: run: shell: bash -l {0} - working-directory: argilla + working-directory: extralit steps: - name: Checkout Code 🛎 @@ -110,12 +159,12 @@ jobs: - name: Update repo visualizer uses: githubocto/repo-visualizer@0.7.1 with: - root_path: "argilla/" + root_path: "extralit/" excluded_paths: "dist,build,node_modules,docs,tests,.swm,assets,.github,package-lock.json,pdm.lock" excluded_globs: "*.spec.js;**/*.{png,jpg,svg,md};**/!(*.module).ts,**/__pycache__/,**/__mocks__/,LICENSE*,**/.gitignore,**/*.egg-info/,**/.*/" output_file: "repo-visualizer.svg" should_push: false - + - name: Upload repo visualizer diagram as artifact uses: actions/upload-artifact@v4 with: @@ -126,16 +175,20 @@ jobs: - name: Download python package uses: actions/download-artifact@v4 with: - name: argilla - path: argilla/dist + name: extralit + path: extralit/dist - - name: Setup PDM - uses: pdm-project/setup-pdm@v4 + - name: Install uv + uses: astral-sh/setup-uv@v5 with: - cache: true - python-version-file: argilla/pyproject.toml - cache-dependency-path: | - argilla/pdm.lock + pyproject-file: "extralit/pyproject.toml" + python-version: "3.9" + enable-cache: true + cache-local-path: ~/.cache/uv + ignore-nothing-to-cache: true + cache-dependency-glob: "extralit/pdm.lock" + - name: Install PDM + run: uv tool install pdm - name: Read package info run: | diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml index 9c17dffe8..b4815f495 100644 --- a/.github/workflows/scorecard.yml +++ b/.github/workflows/scorecard.yml @@ -13,7 +13,7 @@ on: # - cron: '15 16 * * 3' pull_request: paths: - - "argilla/**" + - "extralit/**" - "argilla-server/**" # Declare default permissions as read only. diff --git a/.gitignore b/.gitignore index 947fe2fa5..c33d22179 100644 --- a/.gitignore +++ b/.gitignore @@ -138,7 +138,9 @@ sw.* # yarn & npm yarn.lock -package-lock.json + +# App generated files +src/**/server/static/ # Old users db file .users.yml @@ -151,4 +153,4 @@ package-lock.json # App generated files argilla-server/src/argilla_server/static -argilla/site +extralit/site diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 86929db9b..e72f43c19 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,7 +3,7 @@ repos: rev: v4.6.0 hooks: - id: check-yaml - exclude: argilla/mkdocs.yml|examples/deployments/k8s + exclude: extralit/mkdocs.yml|examples/deployments/k8s - id: end-of-file-fixer exclude_types: [text, jupyter] - id: trailing-whitespace @@ -14,14 +14,14 @@ repos: - id: ruff-format ############################################################################## - # argilla specific hooks + # extralit SDK specific hooks ############################################################################## - repo: https://github.com/pycqa/autoflake rev: v2.2.1 hooks: - id: autoflake - name: "Remove unused imports and variables in argilla" - files: '^argilla/.*\.py$' + name: "Remove unused imports and variables" + files: '^extralit/.*\.py$' args: - "--remove-all-unused-imports" - "--remove-unused-variables" @@ -30,7 +30,7 @@ repos: rev: v0.4.8 hooks: - id: ruff - files: 'argilla/src/.*\.py$' + files: 'extralit/src/.*\.py$' args: - --fix - repo: https://github.com/Lucas-C/pre-commit-hooks @@ -38,17 +38,17 @@ repos: hooks: - id: insert-license name: "Insert license header in Python source files" - files: '^argilla/.*\.py$' - exclude: ^argilla/docs/snippets/ + files: '^extralit/.*\.py$' + exclude: ^extralit/docs/snippets/ args: - --license-filepath - - argilla/LICENSE_HEADER + - extralit/LICENSE_HEADER - --fuzzy-match-generates-todo - repo: https://github.com/kynan/nbstripout rev: 0.7.1 hooks: - id: nbstripout - files: '^argilla/.*\.ipynb$' + files: '^extralit/.*\.ipynb$' args: - --keep-count - --keep-output @@ -59,6 +59,7 @@ repos: # - --keep-execution-count # - --keep-metadata # - --keep-version + ############################################################################## # argilla-server specific hooks ############################################################################## @@ -92,6 +93,37 @@ repos: - argilla-server/LICENSE_HEADER - --fuzzy-match-generates-todo + ############################################################################## + # argilla-v1 SDK specific hooks + ############################################################################## + - repo: https://github.com/pycqa/autoflake + rev: v2.2.1 + hooks: + - id: autoflake + name: "Remove unused imports and variables" + files: '^argilla-v1/.*\.py$' + args: + - "--remove-all-unused-imports" + - "--remove-unused-variables" + - "--in-place" + - repo: https://github.com/charliermarsh/ruff-pre-commit + rev: v0.4.8 + hooks: + - id: ruff + files: 'argilla-v1/src/.*\.py$' + args: + - --fix + - repo: https://github.com/Lucas-C/pre-commit-hooks + rev: v1.5.5 + hooks: + - id: insert-license + name: "Insert license header in Python source files" + files: '^argilla-v1/.*\.py$' + args: + - --license-filepath + - extralit/LICENSE_HEADER + - --fuzzy-match-generates-todo + ############################################################################## # Helm lint hook ############################################################################## diff --git a/README.md b/README.md index 3086dc730..0f35876bf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- Extralit + Extralit

@@ -15,11 +15,13 @@ Extralit (EXTRAct LITerature) is a data extraction workflow with user-friendly UI, designed for **LLM-assisted scientific data extraction** and other **unstructured document intelligence** tasks. It focuses on data accuracy above all else, and further integrates human feedback loops for continuous LLM refinement and collaborative data extraction. +Why Use Extralit? + - 🔹 Precision First – Built for high data accuracy, ensuring reliable results. - 🔹 Human-in-the-Loop – Seamlessly integrate human annotations to refine LLM outputs and collaborate on data validation. - 🔹 Flexible & Scalable – Available as a Python SDK, CLI, and Web UI with multiple deployment options to fit your workflow. -🌟 Key Features +Key Features: - ✅ Schema-Driven Extraction – Define structured schemas for context-aware, high-accuracy data extraction across scientific domains. - ✅ Advanced PDF Processing – AI-powered OCR detects complex table structures in both digital and scanned PDFs. @@ -29,6 +31,11 @@ Extralit (EXTRAct LITerature) is a data extraction workflow with user-friendly U Start extracting smarter with Extralit! 🚀 +## Recent News + +- **May 2025**: Extralit selected for Google Summer of Code 2025! We're working on Scientific PDF Data Extraction and Interactive Schema Editor UI projects. +- **Looking to contribute?** Check out our GSoC projects or open issues to get started! + ## Getting started ### Installation @@ -60,5 +67,4 @@ Extralit is built on top of Argilla, extending its capabilities with enhanced da ## Repo Activity -![Alt](https://repobeats.axiom.co/api/embed/503055f15ba7ac2f51d697153f7c146ae81c6c04.svg "Repobeats analytics image") - +![Alt](https://repobeats.axiom.co/api/embed/3837e8b3ea152454b555ace7b6675060649004b7.svg "Repobeats analytics image") diff --git a/Tiltfile b/Tiltfile index 3074b9513..76a89cfb9 100644 --- a/Tiltfile +++ b/Tiltfile @@ -91,7 +91,7 @@ docker_build( context='argilla-server/', build_args={'ENV': ENV, 'USERS_DB': USERS_DB}, dockerfile='argilla-server/docker/server/dev.argilla_server.dockerfile', - ignore=['examples/', 'argilla/', '.*', '**/__pycache__', '*.pyc', 'CHANGELOG.md'], + ignore=['examples/', 'extralit/', '.*', '**/__pycache__', '*.pyc', 'CHANGELOG.md'], live_update=[ # Sync the source code to the container sync('argilla-server/src/', '/home/argilla/src/'), @@ -166,15 +166,15 @@ helm_resource( ) # Extralit server -if not os.path.exists('argilla/dist/'): - local('pdm build', dir='argilla') +if not os.path.exists('extralit/dist/'): + local('pdm build', dir='extralit') docker_build( "{DOCKER_REPO}/extralit-server".format(DOCKER_REPO=DOCKER_REPO), - context='argilla/', - dockerfile='argilla/docker/extralit.dockerfile', + context='extralit/', + dockerfile='extralit/docker/extralit.dockerfile', ignore=['.*', 'argilla-frontend/', 'argilla-server/', '**/__pycache__', '*.pyc'], live_update=[ - sync('argilla/', '/home/extralit/'), + sync('extralit/', '/home/extralit/'), ] ) extralit_k8s_yaml = read_yaml_stream('examples/deployments/k8s/extralit-deployment.yaml') diff --git a/argilla-frontend/CHANGELOG.md b/argilla-frontend/CHANGELOG.md index 0011dffbd..c0b1b7ecb 100644 --- a/argilla-frontend/CHANGELOG.md +++ b/argilla-frontend/CHANGELOG.md @@ -14,10 +14,34 @@ These are the section headers that we use: * "Security" in case of vulnerabilities. --> -## [Extralit] [0.4.0](https://github.com/extralit/extralit/compare/v0.3.0...v0.4.0) +## [Extralit] [0.5.0](https://github.com/extralit/extralit/compare/v0.4.1...v0.5.0) + + +## [Argilla] [2.8.0](https://github.com/argilla-io/argilla/compare/v2.7.1...v2.8.0) + +### Added + +- Added Japanese language ([#5816](https://github.com/argilla-io/argilla/pull/5816)). Contributed by @Tomoya-Matsubara. + +## [Argilla] [2.7.1](https://github.com/argilla-io/argilla/compare/v2.7.0...v2.7.1) + ### Fixed -- Fixed ES index type for TableField and TableQuestion +- Fixed error when requesting dataset info the datasets-viewer API. ([#5804](https://github.com/argilla-io/argilla/pull/5804)) + +## [Argilla] [2.7.0](https://github.com/argilla-io/argilla/compare/v2.6.0...v2.7.0) + +## [Argilla] [2.6.0](https://github.com/argilla-io/argilla/compare/v2.5.0...v2.6.0) + +### Added + +- Add share progress feature ([#5727](https://github.com/argilla-io/argilla/pull/5727)) +- Added feature to export datasets from Argilla to Hugging Face hub from the UI ([#5730](https://github.com/argilla-io/argilla/pull/5730)) + +### Fixed + +- Improved performance and accessibility ([#5724](https://github.com/argilla-io/argilla/pull/5724)) +- Fixed dataset update date information in the dataset list ([#5741](https://github.com/argilla-io/argilla/pull/#5741)) ## [Argilla] [2.5.0](https://github.com/argilla-io/argilla/compare/v2.4.1...v2.5.0) @@ -33,6 +57,11 @@ These are the section headers that we use: - Fixed visible_options when updating question setting. ([#5716](https://github.com/argilla-io/argilla/pull/5716)) - Fixed highlighting on same record ([#5693](https://github.com/argilla-io/argilla/pull/5693)) +## [Extralit] [0.4.0](https://github.com/extralit/extralit/compare/v0.3.0...v0.4.0) + +### Fixed +- Fixed ES index type for TableField and TableQuestion + ## [Extralit] [0.3.0](https://github.com/extralit/extralit/compare/v0.2.3...v0.3.0) ### Added diff --git a/argilla-frontend/README.md b/argilla-frontend/README.md index aa684a45f..ecc782da7 100644 --- a/argilla-frontend/README.md +++ b/argilla-frontend/README.md @@ -1,5 +1,5 @@

- Extralit + Extralit
Extralit Frontend
diff --git a/argilla-frontend/__mocks__/styleMock.js b/argilla-frontend/__mocks__/styleMock.js index e69de29bb..a09954537 100644 --- a/argilla-frontend/__mocks__/styleMock.js +++ b/argilla-frontend/__mocks__/styleMock.js @@ -0,0 +1 @@ +module.exports = {}; \ No newline at end of file diff --git a/argilla-frontend/__mocks__/tabulator-tables.js b/argilla-frontend/__mocks__/tabulator-tables.js new file mode 100644 index 000000000..920d21f84 --- /dev/null +++ b/argilla-frontend/__mocks__/tabulator-tables.js @@ -0,0 +1,142 @@ +// Mock implementation for tabulator-tables +export class TabulatorFull { + constructor() { + this.rows = []; + this.columns = []; + this.data = []; + // Mock all required methods to prevent errors + this.initialized = true; + } + + addRow(data, position, index) { + const newRow = { + _row: { data }, + getData: () => data, + getElement: () => document.createElement("div"), + getTable: () => this, + delete: () => true + }; + this.rows.push(newRow); + this.data.push(data); + return newRow; + } + + getRows() { + return this.rows; + } + + getData() { + return this.data; + } + + getColumns() { + return this.columns.map(col => ({ + getField: () => col.field, + getDefinition: () => col, + getElement: () => document.createElement("div"), + getTable: () => this, + updateDefinition: () => true + })); + } + + deleteRow() { + return true; + } + + clearData() { + this.rows = []; + this.data = []; + return true; + } + + updateData() { + return true; + } + + validate() { + return true; + } + + setData(data) { + this.data = data || []; + this.rows = data ? data.map(item => ({ + data: item, + _row: { data: item }, + getData: () => item, + getElement: () => document.createElement("div") + })) : []; + return true; + } + + on() { + return this; + } + + redraw() { + return true; + } + + updateColumnDefinition() { + return true; + } + + getDataCount() { + return this.data.length; + } + + setSort() { + return this; + } + + setFilter() { + return this; + } + + setPage() { + return this; + } + + setPageSize() { + return this; + } + + getPageSize() { + return 10; + } + + getPage() { + return 1; + } + + getPageMax() { + return 1; + } +} + +// Column component needed by tests +export class ColumnComponent { + constructor(field, title) { + this.field = field; + this.title = title; + } + + getField() { + return this.field; + } + + getDefinition() { + return { + field: this.field, + title: this.title + }; + } + + updateDefinition() { + return true; + } +} + +export default { + TabulatorFull, + ColumnComponent +}; \ No newline at end of file diff --git a/argilla-frontend/assets/css/fonts.css b/argilla-frontend/assets/css/fonts.css new file mode 100644 index 000000000..b5e792658 --- /dev/null +++ b/argilla-frontend/assets/css/fonts.css @@ -0,0 +1,7 @@ +@font-face { + font-family: "raptor_v2_premiumbold"; + src: url("/fonts/raptorv2premium-bold-webfont.woff2") format("woff2"), + url("/fonts/raptorv2premium-bold-webfont.woff") format("woff"); + font-weight: normal; + font-style: normal; +} diff --git a/argilla-frontend/assets/scss/abstract/variables/_themes.scss b/argilla-frontend/assets/css/themes.css similarity index 100% rename from argilla-frontend/assets/scss/abstract/variables/_themes.scss rename to argilla-frontend/assets/css/themes.css diff --git a/argilla-frontend/assets/icons/export.js b/argilla-frontend/assets/icons/export.js new file mode 100644 index 000000000..236f247c5 --- /dev/null +++ b/argilla-frontend/assets/icons/export.js @@ -0,0 +1,27 @@ +/* + * coding=utf-8 + * Copyright 2021-present, the Recognai S.L. team. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/* eslint-disable */ +var icon = require('vue-svgicon') +icon.register({ + 'export': { + width: 26, + height: 31, + viewBox: '0 0 26 31', + data: '' + } +}) \ No newline at end of file diff --git a/argilla-frontend/assets/icons/index.js b/argilla-frontend/assets/icons/index.js index 53de88bc0..36e92d023 100644 --- a/argilla-frontend/assets/icons/index.js +++ b/argilla-frontend/assets/icons/index.js @@ -19,6 +19,7 @@ require('./discard') require('./draggable') require('./expand-arrows') require('./exploration') +require('./export') require('./external-link') require('./external') require('./filter') diff --git a/argilla-frontend/assets/scss/abstract.scss b/argilla-frontend/assets/scss/abstract.scss index 58b4f002f..c49350b56 100644 --- a/argilla-frontend/assets/scss/abstract.scss +++ b/argilla-frontend/assets/scss/abstract.scss @@ -16,10 +16,8 @@ */ // abstract -@import "abstract/fonts/fonts"; @import "abstract/functions/functions"; @import "abstract/variables/variables"; -@import "abstract/variables/themes"; @import "abstract/mixins/mixins"; @import "abstract/mixins/media-queries"; @import "abstract/mixins/grid-mixins"; diff --git a/argilla-frontend/assets/scss/abstract/fonts/fonts.scss b/argilla-frontend/assets/scss/abstract/fonts/fonts.scss deleted file mode 100644 index eb5f01b15..000000000 --- a/argilla-frontend/assets/scss/abstract/fonts/fonts.scss +++ /dev/null @@ -1,7 +0,0 @@ -@font-face { - font-family: "raptor_v2_premiumbold"; - src: url("@/assets/fonts/raptorv2premium-bold-webfont.woff2") format("woff2"), - url("@/assets/fonts/raptorv2premium-bold-webfont.woff") format("woff"); - font-weight: normal; - font-style: normal; -} diff --git a/argilla-frontend/assets/scss/abstract/mixins/_media-queries.scss b/argilla-frontend/assets/scss/abstract/mixins/_media-queries.scss index 131e764b9..8d50cb951 100644 --- a/argilla-frontend/assets/scss/abstract/mixins/_media-queries.scss +++ b/argilla-frontend/assets/scss/abstract/mixins/_media-queries.scss @@ -16,33 +16,20 @@ */ @charset "UTF-8"; -// _ _ _ _ _ -// (_) | | | | | (_) -// _ _ __ ___| |_ _ __| | ___ _ __ ___ ___ __| |_ __ _ -// | | '_ \ / __| | | | |/ _` |/ _ \ | '_ ` _ \ / _ \/ _` | |/ _` | -// | | | | | (__| | |_| | (_| | __/ | | | | | | __/ (_| | | (_| | -// |_|_| |_|\___|_|\__,_|\__,_|\___| |_| |_| |_|\___|\__,_|_|\__,_| -// -// Simple, elegant and maintainable media queries in Sass -// v1.4.9 -// -// http://include-media.com -// -// Authors: Eduardo Boucas (@eduardoboucas) -// Hugo Giraudel (@hugogiraudel) -// -// This project is licensed under the terms of the MIT license -//// -/// include-media library public configuration -/// @author Eduardo Boucas -/// @access public -//// -/// -/// Creates a list of global breakpoints -/// -/// @example scss - Creates a single breakpoint with the label `phone` -/// $breakpoints: ('phone': 320px); -/// +// Simple, elegant and maintainable media queries in Sass +// v1.4.9 +// http://include-media.com +// Authors: Eduardo Boucas (@eduardoboucas) +// Hugo Giraudel (@hugogiraudel) +// This project is licensed under the terms of the MIT license + +// include-media library public configuration +// @author Eduardo Boucas +// @access public + +// Creates a list of global breakpoints +// @example scss - Creates a single breakpoint with the label `phone` +// $breakpoints: ('phone': 320px); $breakpoints: ( "phone": 320px, "tablet": 768px, @@ -50,17 +37,14 @@ $breakpoints: ( "desktopLarge": 1440px, "xxl": 1900px, ) !default; -/// -/// Creates a list of static expressions or media types -/// -/// @example scss - Creates a single media type (screen) -/// $media-expressions: ('screen': 'screen'); -/// -/// @example scss - Creates a static expression with logical disjunction (OR operator) -/// $media-expressions: ( -/// 'retina2x': '(-webkit-min-device-pixel-ratio: 2), (min-resolution: 192dpi)' -/// ); -/// + +// Creates a list of static expressions or media types +// @example scss - Creates a single media type (screen) +// $media-expressions: ('screen': 'screen'); +// @example scss - Creates a static expression with logical disjunction (OR operator) +// $media-expressions: ( +// 'retina2x': '(-webkit-min-device-pixel-ratio: 2), (min-resolution: 192dpi)' +// ); $media-expressions: ( "screen": "screen", "print": "print", @@ -72,125 +56,102 @@ $media-expressions: ( "retina3x": "(-webkit-min-device-pixel-ratio: 3), (min-resolution: 350dpi), (min-resolution: 3dppx)", ) !default; -/// -/// Defines a number to be added or subtracted from each unit when declaring breakpoints with exclusive intervals -/// -/// @example scss - Interval for pixels is defined as `1` by default -/// @include media('>128px') {} -/// -/// /* Generates: */ -/// @media (min-width: 129px) {} -/// -/// @example scss - Interval for ems is defined as `0.01` by default -/// @include media('>20em') {} -/// -/// /* Generates: */ -/// @media (min-width: 20.01em) {} -/// -/// @example scss - Interval for rems is defined as `0.1` by default, to be used with `font-size: 62.5%;` -/// @include media('>2.0rem') {} -/// -/// /* Generates: */ -/// @media (min-width: 2.1rem) {} -/// + +// Defines a number to be added or subtracted from each unit when declaring breakpoints with exclusive intervals +// @example scss - Interval for pixels is defined as `1` by default +// @include media('>128px') {} +// /* Generates: */ +// @media (min-width: 129px) {} +// @example scss - Interval for ems is defined as `0.01` by default +// @include media('>20em') {} +// /* Generates: */ +// @media (min-width: 20.01em) {} +// @example scss - Interval for rems is defined as `0.1` by default, to be used with `font-size: 62.5%;` +// @include media('>2.0rem') {} +// /* Generates: */ +// @media (min-width: 2.1rem) {} $unit-intervals: ( "px": 1, "em": 0.01, "rem": 0.1, "": 0, ) !default; -/// -/// Defines whether support for media queries is available, useful for creating separate stylesheets -/// for browsers that don't support media queries. -/// -/// @example scss - Disables support for media queries -/// $im-media-support: false; -/// @include media('>=tablet') { -/// .foo { -/// color: tomato; -/// } -/// } -/// -/// /* Generates: */ -/// .foo { -/// color: tomato; -/// } -/// + +// Defines whether support for media queries is available, useful for creating separate stylesheets +// for browsers that don't support media queries. +// @example scss - Disables support for media queries +// $im-media-support: false; +// @include media('>=tablet') { +// .foo { +// color: tomato; +// } +// } +// /* Generates: */ +// .foo { +// color: tomato; +// } $im-media-support: true !default; -/// -/// Selects which breakpoint to emulate when support for media queries is disabled. Media queries that start at or -/// intercept the breakpoint will be displayed, any others will be ignored. -/// -/// @example scss - This media query will show because it intercepts the static breakpoint -/// $im-media-support: false; -/// $im-no-media-breakpoint: 'desktop'; -/// @include media('>=tablet') { -/// .foo { -/// color: tomato; -/// } -/// } -/// -/// /* Generates: */ -/// .foo { -/// color: tomato; -/// } -/// -/// @example scss - This media query will NOT show because it does not intercept the desktop breakpoint -/// $im-media-support: false; -/// $im-no-media-breakpoint: 'tablet'; -/// @include media('>=desktop') { -/// .foo { -/// color: tomato; -/// } -/// } -/// -/// /* No output */ -/// + +// Selects which breakpoint to emulate when support for media queries is disabled. Media queries that start at or +// intercept the breakpoint will be displayed, any others will be ignored. +// @example scss - This media query will show because it intercepts the static breakpoint +// $im-media-support: false; +// $im-no-media-breakpoint: 'desktop'; +// @include media('>=tablet') { +// .foo { +// color: tomato; +// } +// } +// /* Generates: */ +// .foo { +// color: tomato; +// } +// @example scss - This media query will NOT show because it does not intercept the desktop breakpoint +// $im-media-support: false; +// $im-no-media-breakpoint: 'tablet'; +// @include media('>=desktop') { +// .foo { +// color: tomato; +// } +// } +// /* No output */ $im-no-media-breakpoint: "desktop" !default; -/// -/// Selects which media expressions are allowed in an expression for it to be used when media queries -/// are not supported. -/// -/// @example scss - This media query will show because it intercepts the static breakpoint and contains only accepted media expressions -/// $im-media-support: false; -/// $im-no-media-breakpoint: 'desktop'; -/// $im-no-media-expressions: ('screen'); -/// @include media('>=tablet', 'screen') { -/// .foo { -/// color: tomato; -/// } -/// } -/// -/// /* Generates: */ -/// .foo { -/// color: tomato; -/// } -/// -/// @example scss - This media query will NOT show because it intercepts the static breakpoint but contains a media expression that is not accepted -/// $im-media-support: false; -/// $im-no-media-breakpoint: 'desktop'; -/// $im-no-media-expressions: ('screen'); -/// @include media('>=tablet', 'retina2x') { -/// .foo { -/// color: tomato; -/// } -/// } -/// -/// /* No output */ -/// + +// Selects which media expressions are allowed in an expression for it to be used when media queries +// are not supported. +// @example scss - This media query will show because it intercepts the static breakpoint and contains only accepted media expressions +// $im-media-support: false; +// $im-no-media-breakpoint: 'desktop'; +// $im-no-media-expressions: ('screen'); +// @include media('>=tablet', 'screen') { +// .foo { +// color: tomato; +// } +// } +// /* Generates: */ +// .foo { +// color: tomato; +// } +// @example scss - This media query will NOT show because it intercepts the static breakpoint but contains a media expression that is not accepted +// $im-media-support: false; +// $im-no-media-breakpoint: 'desktop'; +// $im-no-media-expressions: ('screen'); +// @include media('>=tablet', 'retina2x') { +// .foo { +// color: tomato; +// } +// } +// /* No output */ $im-no-media-expressions: ("screen", "portrait", "landscape") !default; -//// -/// Cross-engine logging engine -/// @author Hugo Giraudel -/// @access private -//// -/// -/// Log a message either with `@error` if supported -/// else with `@warn`, using `feature-exists('at-error')` -/// to detect support. -/// -/// @param {String} $message - Message to log -/// + +// Cross-engine logging engine +// @author Hugo Giraudel +// @access private + +// Log a message either with `@error` if supported +// else with `@warn`, using `feature-exists('at-error')` +// to detect support. +// @param {String} $message - Message to log @function im-log($message) { @if feature-exists("at-error") { @error $message; @@ -201,33 +162,24 @@ $im-no-media-expressions: ("screen", "portrait", "landscape") !default; @return $message; } -/// -/// Wrapper mixin for the log function so it can be used with a more friendly -/// API than `@if im-log('..') {}` or `$_: im-log('..')`. Basically, use the function -/// within functions because it is not possible to include a mixin in a function -/// and use the mixin everywhere else because it's much more elegant. -/// -/// @param {String} $message - Message to log -/// +// Wrapper mixin for the log function so it can be used with a more friendly +// API than `@if im-log('..') {}` or `$_: im-log('..')`. Basically, use the function +// within functions because it is not possible to include a mixin in a function +// and use the mixin everywhere else because it's much more elegant. +// @param {String} $message - Message to log @mixin log($message) { @if im-log($message) { } } -/// -/// Function with no `@return` called next to `@warn` in Sass 3.3 -/// to trigger a compiling error and stop the process. -/// +// Function with no `@return` called next to `@warn` in Sass 3.3 +// to trigger a compiling error and stop the process. @function noop() { } -/// -/// Determines whether a list of conditions is intercepted by the static breakpoint. -/// -/// @param {Arglist} $conditions - Media query conditions -/// -/// @return {Boolean} - Returns true if the conditions are intercepted by the static breakpoint -/// +// Determines whether a list of conditions is intercepted by the static breakpoint. +// @param {Arglist} $conditions - Media query conditions +// @return {Boolean} - Returns true if the conditions are intercepted by the static breakpoint @function im-intercepts-static-breakpoint($conditions...) { $no-media-breakpoint-value: map-get($breakpoints, $im-no-media-breakpoint); @if not $no-media-breakpoint-value { @@ -251,24 +203,20 @@ $im-no-media-expressions: ("screen", "portrait", "landscape") !default; @return true; } -//// -/// Parsing engine -/// @author Hugo Giraudel -/// @access private -//// -/// -/// Get operator of an expression -/// -/// @param {String} $expression - Expression to extract operator from -/// -/// @return {String} - Any of `>=`, `>`, `<=`, `<`, `≥`, `≤` -/// +// Parsing engine +// @author Hugo Giraudel +// @access private + +// Get operator of an expression +// @param {String} $expression - Expression to extract operator from +// @return {String} - Any of `>=`, `>`, `<=`, `<`, `≥`, `≤` @function get-expression-operator($expression) { @each $operator in (">=", ">", "<=", "<", "≥", "≤") { @if str-index($expression, $operator) { @return $operator; } - } // It is not possible to include a mixin inside a function, so we have to + } + // It is not possible to include a mixin inside a function, so we have to // rely on the `im-log(..)` function rather than the `log(..)` mixin. Because // functions cannot be called anywhere in Sass, we need to hack the call in // a dummy variable, such as `$_`. If anybody ever raise a scoping issue with @@ -276,14 +224,10 @@ $im-no-media-expressions: ("screen", "portrait", "landscape") !default; $_: im-log("No operator found in `#{$expression}`."); } -/// -/// Get dimension of an expression, based on a found operator -/// -/// @param {String} $expression - Expression to extract dimension from -/// @param {String} $operator - Operator from `$expression` -/// -/// @return {String} - `width` or `height` (or potentially anything else) -/// +// Get dimension of an expression, based on a found operator +// @param {String} $expression - Expression to extract dimension from +// @param {String} $operator - Operator from `$expression` +// @return {String} - `width` or `height` (or potentially anything else) @function get-expression-dimension($expression, $operator) { $operator-index: str-index($expression, $operator); $parsed-dimension: str-slice($expression, 0, $operator-index - 1); @@ -294,25 +238,17 @@ $im-no-media-expressions: ("screen", "portrait", "landscape") !default; @return $dimension; } -/// -/// Get dimension prefix based on an operator -/// -/// @param {String} $operator - Operator -/// -/// @return {String} - `min` or `max` -/// +// Get dimension prefix based on an operator +// @param {String} $operator - Operator +// @return {String} - `min` or `max` @function get-expression-prefix($operator) { @return if(index(("<", "<=", "≤"), $operator), "max", "min"); } -/// -/// Get value of an expression, based on a found operator -/// -/// @param {String} $expression - Expression to extract value from -/// @param {String} $operator - Operator from `$expression` -/// -/// @return {Number} - A numeric value -/// +// Get value of an expression, based on a found operator +// @param {String} $expression - Expression to extract value from +// @param {String} $operator - Operator from `$expression` +// @return {Number} - A numeric value @function get-expression-value($expression, $operator) { $operator-index: str-index($expression, $operator); $value: str-slice($expression, $operator-index + str-length($operator)); @@ -338,13 +274,9 @@ $im-no-media-expressions: ("screen", "portrait", "landscape") !default; @return $value; } -/// -/// Parse an expression to return a valid media-query expression -/// -/// @param {String} $expression - Expression to parse -/// -/// @return {String} - Valid media query -/// +// Parse an expression to return a valid media-query expression +// @param {String} $expression - Expression to parse +// @return {String} - Valid media query @function parse-expression($expression) { // If it is part of $media-expressions, it has no operator // then there is no need to go any further, just return the value @@ -358,17 +290,12 @@ $im-no-media-expressions: ("screen", "portrait", "landscape") !default; @return "(#{$prefix}-#{$dimension}: #{$value})"; } -/// -/// Slice `$list` between `$start` and `$end` indexes -/// -/// @access private -/// -/// @param {List} $list - List to slice -/// @param {Number} $start [1] - Start index -/// @param {Number} $end [length($list)] - End index -/// -/// @return {List} Sliced list -/// +// Slice `$list` between `$start` and `$end` indexes +// @access private +// @param {List} $list - List to slice +// @param {Number} $start [1] - Start index +// @param {Number} $end [length($list)] - End index +// @return {List} Sliced list @function slice($list, $start: 1, $end: length($list)) { @if length($list) < 1 or $start>$end { @return (); @@ -380,18 +307,13 @@ $im-no-media-expressions: ("screen", "portrait", "landscape") !default; @return $result; } -//// -/// String to number converter -/// @author Hugo Giraudel -/// @access private -//// -/// -/// Casts a string into a number -/// -/// @param {String | Number} $value - Value to be parsed -/// -/// @return {Number} -/// +// String to number converter +// @author Hugo Giraudel +// @access private + +// Casts a string into a number +// @param {String | Number} $value - Value to be parsed +// @return {Number} @function to-number($value) { @if type-of($value) == "number" { @return $value; @@ -413,7 +335,8 @@ $im-no-media-expressions: ("screen", "portrait", "landscape") !default; "7": 7, "8": 8, "9": 9, - ); // Remove +/- sign if present at first character + ); + // Remove +/- sign if present at first character @if ($first-character== "+" or $first-character== "-") { $value: str-slice($value, 2); } @@ -434,6 +357,83 @@ $im-no-media-expressions: ("screen", "portrait", "landscape") !default; @return if($minus, -$result, $result); } +// Add `$unit` to `$value` +// @param {Number} $value - Value to add unit to +// @param {String} $unit - String representation of the unit +// @return {Number} - `$value` expressed in `$unit` +@function to-length($value, $unit) { + $units: ( + "px": 1px, + "cm": 1cm, + "mm": 1mm, + "%": 1%, + "ch": 1ch, + "pc": 1pc, + "in": 1in, + "em": 1em, + "rem": 1rem, + "pt": 1pt, + "ex": 1ex, + "vw": 1vw, + "vh": 1vh, + "vmin": 1vmin, + "vmax": 1vmax, + ); + @if not index(map-keys($units), $unit) { + $_: im-log("Invalid unit `#{$unit}`."); + } + @return $value * map-get($units, $unit); +} + +// This mixin aims at redefining the configuration just for the scope of +// the call. It is helpful when having a component needing an extended +// configuration such as custom breakpoints (referred to as tweakpoints) +// for instance. +// @author Hugo Giraudel +// @param {Map} $tweakpoints [()] - Map of tweakpoints to be merged with `$breakpoints` +// @param {Map} $tweak-media-expressions [()] - Map of tweaked media expressions to be merged with `$media-expression` +// @example scss - Extend the global breakpoints with a tweakpoint +// @include media-context(('custom': 678px)) { +// .foo { +// @include media('>phone', '<=custom') { +// // ... +// } +// } +// } +// @example scss - Extend the global media expressions with a custom one +// @include media-context($tweak-media-expressions: ('all': 'all')) { +// .foo { +// @include media('all', '>phone') { +// // ... +// } +// } +// } +// @example scss - Extend both configuration maps +// @include media-context(('custom': 678px), ('all': 'all')) { +// .foo { +// @include media('all', '>phone', '<=custom') { +// // ... +// } +// } +// } +@mixin media-context($tweakpoints: (), $tweak-media-expressions: ()) { + // Save global configuration + $global-breakpoints: $breakpoints; + $global-media-expressions: $media-expressions; + // Update global configuration + $breakpoints: map-merge($breakpoints, $tweakpoints) !global; + $media-expressions: map-merge( + $media-expressions, + $tweak-media-expressions + ) !global; + @content; + // Restore global configuration + $breakpoints: $global-breakpoints !global; + $media-expressions: $global-media-expressions !global; +} + +// include-media public exposed API +// @author Eduardo Boucas /// /// Add `$unit` to `$value` /// diff --git a/argilla-frontend/assets/scss/abstract/placeholders/_tooltip.scss b/argilla-frontend/assets/scss/abstract/placeholders/_tooltip.scss index 9ad05632c..aeff1d188 100644 --- a/argilla-frontend/assets/scss/abstract/placeholders/_tooltip.scss +++ b/argilla-frontend/assets/scss/abstract/placeholders/_tooltip.scss @@ -115,7 +115,7 @@ $tooltip-border-radius: $border-radius-s; height: auto; opacity: 1; transition: opacity 0.3s ease 0.2s; - z-index: 2; + z-index: 3; } &:before { opacity: 1; @@ -177,6 +177,10 @@ $tooltip-border-radius: $border-radius-s; top: auto; transform: none; } + } @else if $position == "none" { + &:after { + display: none; + } } &:before { content: none !important; diff --git a/argilla-frontend/assets/scss/base/base.scss b/argilla-frontend/assets/scss/base/base.scss index 515b5e505..383ad3cee 100644 --- a/argilla-frontend/assets/scss/base/base.scss +++ b/argilla-frontend/assets/scss/base/base.scss @@ -16,6 +16,7 @@ */ @import url("https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700;800&display=swap"); +@import url("https://fonts.googleapis.com/css2?family=Roboto+Condensed&display=swap"); html { box-sizing: border-box; -webkit-text-size-adjust: 100%; @@ -53,7 +54,7 @@ body { a, button { - color: var(--fg-secondary); + color: var(--fg-primary); } audio, diff --git a/argilla-frontend/assets/styles.scss b/argilla-frontend/assets/styles.scss new file mode 100644 index 000000000..2925cad23 --- /dev/null +++ b/argilla-frontend/assets/styles.scss @@ -0,0 +1,3 @@ +@import "./css/fonts.css"; +@import "./css/themes.css"; +@import "./scss/base/base.scss"; diff --git a/argilla-frontend/components/base/base-banner/BaseBanner.vue b/argilla-frontend/components/base/base-banner/BaseBanner.vue index 0169d7983..6a091905c 100644 --- a/argilla-frontend/components/base/base-banner/BaseBanner.vue +++ b/argilla-frontend/components/base/base-banner/BaseBanner.vue @@ -77,7 +77,7 @@ export default { }; - + diff --git a/argilla-frontend/components/base/base-button/BaseButton.vue b/argilla-frontend/components/base/base-button/BaseButton.vue index 41704556d..ee7a13a30 100644 --- a/argilla-frontend/components/base/base-button/BaseButton.vue +++ b/argilla-frontend/components/base/base-button/BaseButton.vue @@ -25,6 +25,8 @@ :target="target" :rel="newRel" @click="onClick" + @mouseover="$emit('mouseover')" + @mouseleave="$emit('mouseleave')" > @@ -36,6 +38,8 @@ :loading="loading" :disabled="disabled" @click="onClick" + @mouseover="$emit('mouseover')" + @mouseleave="$emit('mouseleave')" > @@ -48,6 +52,8 @@ :type="type" :disabled="disabled" @click="onClick" + @mouseover="$emit('mouseover')" + @mouseleave="$emit('mouseleave')" >