docs2vecs 0.0.1__tar.gz

docs2vecs-0.0.1/.dockerignore

@@ -0,0 +1 @@
+.venv

docs2vecs-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: Build and test
+on: [push, pull_request, workflow_dispatch]
+jobs:
+  test:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: 'test'
+            python: '3.11'
+            os: 'ubuntu-latest'
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "0.6.3"
+
+    - name: Setup Python
+      run: uv python install ${{ matrix.python }}
+
+    - name: Install the project
+      run: uv sync --all-extras --dev
+
+    - name: Unit tests
+      run: uv run pytest tests
+

docs2vecs-0.0.1/.github/workflows/release-oci-image.yml

@@ -0,0 +1,165 @@
+name: Release
+
+on:
+  push:
+    tags:
+    - v*
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+  # workflow_dispatch:
+  #   inputs:
+  #     tag:
+  #       description: 'Tag to create'
+  #       required: true
+  #       default: 'v0.0.0'
+  #     version:
+  #       description: 'Version to create'
+  #       required: true
+  #       default: '0.0.0'
+permissions:
+    pull-requests: read
+    contents: read
+
+env:
+    OCI_REGISTRY: ghcr.io
+
+jobs:
+    generate-release-version:
+        runs-on: ubuntu-latest
+        outputs:
+            generated_version: ${{ steps.output-generated-version.outputs.generated_version }}
+            image_tag: ${{ steps.generate_tag.outputs.image_tag }}
+            image_tag_latest: ${{ steps.output-generated-version.outputs.image_tag_latest }}
+            tag_prefix: ${{ steps.generate_tag.outputs.tag_prefix }}
+        permissions:
+            contents: write
+            id-token: write
+        steps:
+        -
+            name: Checkout
+            uses: actions/checkout@v4
+            with:
+                fetch-depth: 0
+        -
+            name: Generate next version
+            uses: paulhatch/semantic-version@v5.4.0
+            id: semantic-version
+            with:
+                tag_prefix: 'v'
+                major_pattern: "/((BREAKING CHANGE|BREAKING|breaking|MAJOR|major):?|\\S*!).*/"
+                minor_pattern: '/(FEATURE|feature|MINOR|minor|FEAT|feat):?[^!].*/'
+                version_format: '${major}.${minor}.${patch}'
+        -
+            name: Output generated version
+            id: output-generated-version
+            run: |
+                echo "generated_version=${{ steps.semantic-version.outputs.version }}" >> $GITHUB_OUTPUT
+                echo "image_tag_latest=${{ env.OCI_REGISTRY }}/${repo_name}:latest" >> $GITHUB_OUTPUT
+
+        - 
+            name: Version tag ${{ steps.semantic-version.outputs.version }} on main branch
+            if: ${{ github.ref == 'refs/heads/main' }}
+            shell: bash
+            run: |
+                echo "generated_tag=${{ steps.semantic-version.outputs.version }}" >> $GITHUB_ENV
+                echo "GITHUB_REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
+                echo "tag_prefix=v" >> $GITHUB_OUTPUT
+    
+        - 
+            name: Version tag ${{ steps.semantic-version.outputs.version }} on pull request
+            if: ${{ github.event_name == 'pull_request' }}
+            shell: bash
+            run: |
+                echo "generated_tag=pr-${{github.event.pull_request.number}}-${{ steps.semantic-version.outputs.version }}-$(git rev-parse --short HEAD)" >> $GITHUB_ENV
+                echo "GITHUB_REPO=${GITHUB_REPOSITORY,,}" >> ${GITHUB_ENV}
+                echo "tag_prefix=" >> $GITHUB_OUTPUT
+    
+        - 
+            name: Compute image tag based on version tag ${{ env.generated_tag }}
+            id: generate_tag
+            shell: bash
+            run: |
+                # image tag needs to be all lower case
+                repo_name=$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]')
+                echo "image_tag=${{ env.OCI_REGISTRY }}/${repo_name}:${{ env.generated_tag }}" >> $GITHUB_OUTPUT
+
+    docker-image-release:
+        needs: [generate-release-version]
+        timeout-minutes: 30
+        permissions:
+            contents: read
+            packages: write
+            id-token: write
+        strategy:
+          fail-fast: false
+          matrix:
+            os: [ubuntu-24.04, ubuntu-24.04-arm]
+        runs-on: ${{ matrix.os }}
+        steps:
+          - 
+            uses: actions/checkout@v4
+          - 
+            uses: docker/setup-docker-action@v4.1.0
+          - 
+            name: Login to GitHub Container Registry
+            uses: docker/login-action@v3
+            with:
+                registry: ${{ env.OCI_REGISTRY }}
+                username: ${{ github.actor }}
+                password: ${{ secrets.GITHUB_TOKEN }}
+          - 
+            name: Build image for ${{ matrix.os }}
+            run: |
+              docker build --tag ${{ needs.generate-release-version.outputs.image_tag }}-${{ runner.arch }} .
+              docker images
+              docker run -i ${{ needs.generate-release-version.outputs.image_tag }}-${{ runner.arch }} -h
+              docker image inspect ${{ needs.generate-release-version.outputs.image_tag }}-${{ runner.arch }}
+          -
+            name: Push image for ${{ matrix.os }}
+            if: github.event_name == 'tag' && startsWith(github.ref, 'refs/tags/v')
+            run: |
+              docker push ${{ needs.generate-release-version.outputs.image_tag }}-${{ runner.arch }}
+
+    create-image-release:
+        if: github.event_name == 'tag' && startsWith(github.ref, 'refs/tags/v')
+        permissions:
+            packages: write
+            id-token: write
+            contents: write
+            issues: write
+            pull-requests: write
+
+        needs: [generate-release-version, docker-image-release]
+        runs-on: ubuntu-24.04
+        steps:
+          -
+            uses: actions/checkout@v4
+          -
+            uses: docker/setup-docker-action@v4.1.0
+          -
+            name: Login to GitHub Container Registry
+            uses: docker/login-action@v3
+            with:
+                registry: ${{ env.OCI_REGISTRY }}
+                username: ${{ github.actor }}
+                password: ${{ secrets.GITHUB_TOKEN }}
+          -
+            name: Build manifest and push it registry
+            run: |
+              docker manifest create \
+              ${{ needs.generate-release-version.outputs.image_tag }} \
+              --amend ${{ needs.generate-release-version.outputs.image_tag }}-X64 \
+              --amend ${{ needs.generate-release-version.outputs.image_tag }}-ARM64
+              docker manifest push ${{ needs.generate-release-version.outputs.image_tag }}
+              docker manifest inspect ${{ needs.generate-release-version.outputs.image_tag }}
+
+              docker manifest create \
+              ${{ needs.generate-release-version.outputs.image_tag_latest }} \
+              --amend ${{ needs.generate-release-version.outputs.image_tag_latest }}-X64 \
+              --amend ${{ needs.generate-release-version.outputs.image_tag_latest }}-ARM64
+              docker manifest push ${{ needs.generate-release-version.outputs.image_tag_latest }}
+              docker manifest inspect ${{ needs.generate-release-version.outputs.image_tag_latest }}
+              

docs2vecs-0.0.1/.github/workflows/release-pypi.yml

@@ -0,0 +1,142 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on:
+  push:
+    tags:
+    - v*
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+    outputs:
+        package_name: ${{ steps.build_artifacts.outputs.package_name }}
+        package_version: ${{ steps.build_artifacts.outputs.package_version }}
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m pip install build hatchling hatch-vcs --user
+    - name: Build a binary wheel and a source tarball
+      id: build_artifacts
+      run: |
+        python3 -m build
+        package_name=$(hatchling metadata name)
+        package_version=$(hatchling version)
+        echo "package_name=$package_name" >> $GITHUB_OUTPUT
+        echo "package_version=$package_version" >> $GITHUB_OUTPUT
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/${{ needs.build.outputs.package_name }}
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Delete the stub of Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release delete
+        "$GITHUB_REF_NAME"
+        --repo "$GITHUB_REPOSITORY"
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: |
+        gh release create "$GITHUB_REF_NAME" \
+          --title "Release "$GITHUB_REF_NAME" \
+          --generate-notes \
+          --repo "$GITHUB_REPOSITORY"
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        "$GITHUB_REF_NAME" dist/**
+        --repo "$GITHUB_REPOSITORY"
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    # we only publish to TestPyPI on tag pushes or merge to main
+    if: startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main'
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/${{ needs.build.outputs.package_name }}
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/

docs2vecs-0.0.1/.gitignore

@@ -0,0 +1,76 @@
+*.py[cod]
+__pycache__
+
+# Temp files
+.*.sw[po]
+*~
+*.bak
+.DS_Store
+
+# C extensions
+*.so
+
+# Build and package files
+*.egg
+*.egg-info
+.bootstrap
+.build
+.cache
+.eggs
+.env
+.installed.cfg
+.ve
+bin
+build
+develop-eggs
+dist
+eggs
+lib
+lib64
+parts
+pip-wheel-metadata/
+pyvenv*/
+sdist
+var
+venv*/
+.venv*/
+wheelhouse
+src/docs2vecs/_version.py
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.benchmarks
+.coverage
+.coverage.*
+.pytest
+.pytest_cache/
+.tox
+coverage.xml
+htmlcov
+nosetests.xml
+
+# Translations
+*.mo
+
+# Buildout
+.mr.developer.cfg
+
+# IDE project files
+*.iml
+*.komodoproject
+.idea
+.project
+.pydevproject
+.vscode
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
+
+# Mypy Cache
+.mypy_cache/

docs2vecs-0.0.1/.python-version

@@ -0,0 +1 @@
+3.11

docs2vecs-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,90 @@
+### Community guidelines
+ * Be respectful to others
+ * Be appreciative and welcoming
+ * Don't be judgmental
+ * Be patient and supportive to newcomers
+ * Value each contribution, even if it's not perfect - we can work as a team to benefit even from a failed attempt as we can learn from it!
+ * Look after one another - we are community of like-minded people who care about others, not only about ticking the boxes
+ * A challenge is not a bad thing, as it leads to expanding the horizons, being to competitive leads to unhealthy situations - be reasonable here
+
+### Code conventions
+Please follow the standard python rules if possible:
+  * existing conventions
+  * [PEP8](https://www.python.org/dev/peps/pep-0008/)
+  * [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html)
+
+There is always room for opportunistic refactoring, but be careful and ensure the cosmetic changes have no adverse impact on performance or readability.
+
+### Testing conventions
+The project comes which a suite of unit tests covering most of the aspects. Make sure you pass all the existing tests locally before submitting the PR. Furthermore, any new feature, flow or the amendment of the existing one should be reflected in newly added unit tests or the update of the existing tests depending on the context.
+
+Please follow [pytest good practices](https://docs.pytest.org/en/stable/goodpractices.html). You can also draw some inspirations from [this article](https://realpython.com/pytest-python-testing/).
+
+Make sure you test the syntax before submitting the PR. Run a local build if you can and verify if all the new extra resources are also checked in.
+
+### Branching conventions
+We are working with a single master branch and one release branch to make is simple.
+
+### Commit-message conventions
+ * Prefix each commit with the Jira/GitHub Issue ticket number if possible i.e. [ABC-123] New package nnn added to allow running bbb
+ * Provide a high level summary of the changes. Try to be concise.
+ * Make the commit messages meaningful. Don't skip them. They may be helpful during the code review and act as a passive documentation going forwards.
+
+### Steps for creating good pull requests
+  * State your intent is very clearly
+  * If there is a need to provide a thorough explanation or refer to external sources, please do it - it will help in the review
+  * Use the Jira/GitHub Issue ticket as a prefix in the PR title to ensure we get nice cross-references
+  * If you are unsure about certain aspects, don't be scared of asking on the available forums ahead of creating the PR.
+  * If you are aware of some drawback of the changes introduced be transparent about it, the reviewers will weigh pros and cons and your contribution may still be accepted
+  * To stick to a reasonable number of commits in your PR, you  may want to squash some of them using [the git  history rewriting technique](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History)
+  * You can use the PR as a medium for the conversation between  yourself and the project maintainers. You can prefix the PR with a meaningful tag eg. [IDEA], [SUGGESTION], [REMARK] etc. In such case your PR may never be integrated if what you are proposing is not in line with the general direction the project is going to. However, it would be still a valuable resource to track the discussion that took place and it may save time for somebody who is heading in a similar direction.
+
+### Expected timelines(SLAs) for the code review and the integration
+ * The PRs should be reviewed within 1 week at least
+ * The integration happens immediately after the PR is approved and merged into the target branch 
+
+### How to submit feature requests
+ * You may want to discuss the feature on the teams channel or other forums availabe for the project
+ * Use Jra board or GitHub Issues associated to this project
+ * Link the PR(when the contribution is planned) with the Jira ticket/GitHub issue if possible - it may give us more context and will make the case for the change stronger
+ * Please be thorough with the description
+ * Highlight a reasonable timescale you wish the feature to be integrated within - it is helpful when prioritizing 
+
+### How to submit bug reports
+ * Check carefully the documentaion and by asking on the available forums if the behaviour you are experiencing is expected or if it is a bug
+ * Use Issues board associated to the project
+ * Link the PR(when the contribution is planned) with the bug report request if possible - it may give us more context
+ * Please be thorough with the description
+ * Highlight a reasonable timescale you wish the feature to be integrated within - it is helpful when prioritizing 
+
+### How to submit security issue reports
+* Engage with project maintainers. Do not publicly disclose anything before the patch is delivered.
+
+### How to write documentation
+  * README.md and GETTINGSTARTED.md are where we describe the overview, the usage and the development practices
+  * Use [markdown syntax](https://www.markdownguide.org/basic-syntax/) which is widely supported in the GitHub, BitBucket WebUI as well as in many IDEs
+  * Use plain English and check your spelling prior to committing the change
+  * Remember that good documentation is essential, so take time to do it properly
+
+### Dependencies
+All the development dependencies are incorporated into [pyproject.toml](./pyproject.toml).
+
+### Build process schedule
+The deliverable(python wheel) is built as soon as the PR is created, modified or merged into release(main) branch.
+
+### Sprint schedule
+There is no specific scrum setup here. All the changes are worked on in a best effort mode.
+
+### Road map
+There is no roadmap yet. One will be created if there is a need for it.
+
+### When the repositories will be closed to contributions
+At this stage the repositories never get frozen.
+
+### Time reporting
+There is no budget behind this project. Potential contributors need to negotiate it with their line or project managers.
+
+### Helpful links, information, and documentation
+  * [Markdown syntax](https://www.markdownguide.org/basic-syntax/)
+  * [PEP8](https://www.python.org/dev/peps/pep-0008/)
+  * [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html)

docs2vecs-0.0.1/Dockerfile

@@ -0,0 +1,29 @@
+ARG SOURCE_IMAGE_NAME=ubi9/ubi
+FROM registry.access.redhat.com/${SOURCE_IMAGE_NAME}:latest
+
+ARG TARGETPLATFORM
+ARG TARGETARCH
+
+COPY ./etc/ca-bundle.crt /etc/pki/ca-trust/source/anchors/
+COPY ./ /tmp/build
+
+RUN echo "sslverify=0" >> /etc/dnf/dnf.conf \
+    && dnf install -y openssl ca-certificates gcc git \
+    && if [ "$TARGETPLATFORM" ==  "linux/arm64" ]; then\
+        # Creating symlink to /usr/bin/aarch64-linux-gnu-gcc as it is assumed by cython(perhaps worth logging an issue with them)
+        ln -sf /usr/bin/gcc /usr/bin/aarch64-linux-gnu-gcc;\
+       fi \
+    # Remove the insecure setting after install:
+    && sed -i '/sslverify=0/d' /etc/dnf/dnf.conf \
+    && update-ca-trust extract 
+
+RUN curl -LsSf https://astral.sh/uv/install.sh | sh \
+    && source $HOME/.local/bin/env \
+    && uv python install 3.11 \
+    && uv venv \
+    && cd /tmp/build \
+    && uv --native-tls pip install --no-cache . \
+    && uv --native-tls run --script /tmp/build/etc/fetchDefaultModels.py \
+    && rm -rf /tmp/build
+
+ENTRYPOINT ["/root/.local/bin/uv", "--native-tls", "run", "docs2vecs"]

docs2vecs-0.0.1/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c), Amadeus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.