codefinetuner 0.2.0__tar.gz → 0.2.1__tar.gz

{codefinetuner-0.2.0 → codefinetuner-0.2.1}/.github/workflows/release.yaml

@@ -4,6 +4,7 @@ on:
   push:
     tags:
       - '[0-9]*.[0-9]*.[0-9]*'
+      - '!*[a-zA-Z]*'  # ignore any tags that contain letters, this are test release tags
 
 jobs:
   test:
@@ -24,9 +25,20 @@ jobs:
       - name: Run Pytest
         run: uv run pytest
 
+  docker-build-test:
+    name: Docker Build Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+      - name: Build Docker image
+        run: docker build -t codefinetuner-ci-image .
+
   build:
     name: Build Distribution
-    needs: test
+    needs: [test, docker-build-test]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

{codefinetuner-0.2.0 → codefinetuner-0.2.1}/.github/workflows/release_test.yaml

@@ -26,9 +26,20 @@ jobs:
       - name: Run Pytest
         run: uv run pytest
 
+  docker-build-test:
+    name: Docker Build Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+      - name: Build Docker image
+        run: docker build -t codefinetuner-ci-image .
+
   build:
     name: Build Distribution
-    needs: test
+    needs: [test, docker-build-test]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -90,4 +101,5 @@ jobs:
         run: |
           gh release create ${{ github.ref_name }} dist/* \
             --title "${{ github.ref_name }}" \
-            --generate-notes  
+            --generate-notes \
+            --prerelease 

{codefinetuner-0.2.0 → codefinetuner-0.2.1}/.github/workflows/tests.yaml

@@ -21,4 +21,15 @@ jobs:
       - name: Install Dependencies
         run: uv sync --group dev
       - name: Run Pytest
-        run: uv run pytest
+        run: uv run pytest
+
+  docker-build-test:
+    name: Docker Build Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+      - name: Build Docker image
+        run: docker build -t codefinetuner-ci-image .

{codefinetuner-0.2.0 → codefinetuner-0.2.1}/Dockerfile

@@ -1,7 +1,7 @@
 FROM python:3.13-slim
 
 # Copy uv binary 
-COPY --from=ghcr.io/astral-sh/uv:0.4.18 /uv /bin/
+COPY --from=ghcr.io/astral-sh/uv:0.11.7 /uv /bin/
 
 WORKDIR /app
 

{codefinetuner-0.2.0 → codefinetuner-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codefinetuner
-Version: 0.2.0
+Version: 0.2.1
 Summary: Add your description here
 Project-URL: Homepage, https://github.com/cuolm/codefinetuner
 Project-URL: Repository, https://github.com/cuolm/codefinetuner.git
@@ -33,7 +33,7 @@ Description-Content-Type: text/markdown
 
 # CodeFinetuner
 [![PyPI](https://img.shields.io/pypi/v/codefinetuner.svg)](https://pypi.org/project/codefinetuner/)
-[![License](https://img.shields.io/github/license/cuolm/codefinetuner.svg)](LICENSE.txt)
+[![License](https://img.shields.io/github/license/cuolm/codefinetuner.svg)](https://github.com/cuolm/codefinetuner/tree/masterLICENSE.txt)
 [![Release](https://github.com/cuolm/codefinetuner/actions/workflows/release.yaml/badge.svg)](https://github.com/cuolm/codefinetuner/actions/workflows/release.yaml)
 [![Tests](https://github.com/cuolm/codefinetuner/actions/workflows/tests.yaml/badge.svg)](https://github.com/cuolm/codefinetuner/actions/workflows/tests.yaml)
 
@@ -41,19 +41,19 @@ CodeFinetuner fine-tunes a local code autocomplete model on your own repository
 It trains a Low-Rank Adapter ([LoRA](https://arxiv.org/abs/2106.09685)) on Fill-In-the-Middle ([FIM](https://arxiv.org/abs/2207.14255)) examples so the model learns the structure and patterns of your codebase.
 
 ## Table of Contents
-- [Architecture](#architecture)
-- [Project Structure](#project-structure)
-- [How Training Examples Are Created](#how-training-examples-are-created)
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-- [Configuration](#configuration)
-- [Usage](#usage)
-- [Finetuned Model Usage](#finetuned-model-usage)
-- [Docker Image](#docker-image)
-- [Tree-sitter Customization](#tree-sitter-customization)
-- [Tests](#tests)
-- [Resources](#resources)
-- [License](#license)
+- [Architecture](https://github.com/cuolm/codefinetuner/tree/master#architecture)
+- [Project Structure](https://github.com/cuolm/codefinetuner/tree/master#project-structure)
+- [How Training Examples Are Created](https://github.com/cuolm/codefinetuner/tree/master#how-training-examples-are-created)
+- [Installation](https://github.com/cuolm/codefinetuner/tree/master#installation)
+- [Quick Start](https://github.com/cuolm/codefinetuner/tree/master#quick-start)
+- [Configuration](https://github.com/cuolm/codefinetuner/tree/master#configuration)
+- [Usage](https://github.com/cuolm/codefinetuner/tree/master#usage)
+- [Finetuned Model Usage](https://github.com/cuolm/codefinetuner/tree/master#finetuned-model-usage)
+- [Docker Image](https://github.com/cuolm/codefinetuner/tree/master#docker-image)
+- [Tree-sitter Customization](https://github.com/cuolm/codefinetuner/tree/master#tree-sitter-customization)
+- [Tests](https://github.com/cuolm/codefinetuner/tree/master#tests)
+- [Resources](https://github.com/cuolm/codefinetuner/tree/master#resources)
+- [License](https://github.com/cuolm/codefinetuner/tree/master#license)
 
 
 ## Architecture
@@ -102,15 +102,15 @@ Here is an example illustrating how a single FIM example is created:
   <tr>
     <td align="center" valign="top">
       <strong>Source Code File</strong><br>
-      <img src="docs/code_file.png" alt="code_file" width="250">
+      <img src="https://raw.githubusercontent.com/cuolm/codefinetuner/master/docs/code_file.png" alt="code_file" width="250">
     </td>
     <td align="center" valign="top">
       <strong>Code Block</strong><br>
-      <img src="docs/code_block.png" alt="code_block" width="250">
+      <img src="https://raw.githubusercontent.com/cuolm/codefinetuner/master/docs/code_block.png" alt="code_block" width="250">
     </td>
     <td align="center" valign="top">
       <strong>One Subblock</strong><br>
-      <img src="docs/code_subblock.png" alt="code_subblock" width="250">
+      <img src="https://raw.githubusercontent.com/cuolm/codefinetuner/master/docs/code_subblock.png" alt="code_subblock" width="250">
     </td>
   </tr>
 </table>
@@ -145,7 +145,7 @@ pip install -e .
 ---
 
 ## Quick Start
-Create a configuration file according to the [Configuration](#configuration) section.
+Create a configuration file according to the [Configuration](https://github.com/cuolm/codefinetuner/tree/master#configuration) section.
 ```python
 import codefinetuner
 
@@ -157,7 +157,7 @@ The pipeline uses a single-source-of-truth YAML configuration file. It utilizes
 
 ### Configuration Structure
 
-Create `codefinetuner_config.yaml` using the template below. For the full parameter list, see the [Configuration Reference Guide](/docs/config-file.md).
+Create `codefinetuner_config.yaml` using the template below. For the full parameter list, see the [Configuration Reference Guide](https://github.com/cuolm/codefinetuner/tree/master/docs/config-file.md).
 
 ```yaml
 # globals contain all the mandatory parameters.
@@ -174,7 +174,7 @@ globals: &globals
   data_extensions: [".c", ".h"]
 
 preprocess:
-  <<: *globals                   # Inherits all global parameters
+  <<: *globals  # inherits all global parameters
   split_mode: "manual"
   max_token_sequence_length: 1024
   # ... (preprocess specific settings)
@@ -194,7 +194,7 @@ convert:
   <<: *globals
   # ... (convert specific settings)
 ```
-> **Note:** See [`config/codefinetuner_config.yaml`](/config/codefinetuner_config.yaml) for a full production example.
+> **Note:** See [`config/codefinetuner_config.yaml`](https://github.com/cuolm/codefinetuner/tree/master/config/codefinetuner_config.yaml) for a full production example.
 
 ### Data Preparation
 Place source files in your `raw_data_path` (default: `workspace_path/data`).
@@ -233,7 +233,7 @@ codefinetuner.run_pipeline(
 
 ## Finetuned Model Usage
 The `convert` stage exports the final model to [GGUF](https://github.com/ggml-org/ggml/blob/master/docs/gguf.md) format for local inference. The resulting file is saved at `outputs/convert/results/lora_model.gguf`. 
-For setup instructions with the VS Code extension [llama.vscode](https://github.com/ggml-org/llama.vscode), see the [inference-vscode](/docs/inference-vscode.md) guide.
+For setup instructions with the VS Code extension [llama.vscode](https://github.com/ggml-org/llama.vscode), see the [inference-vscode](https://github.com/cuolm/codefinetuner/tree/master/docs/inference-vscode.md) guide.
 
 
 ## Docker Image
@@ -266,8 +266,8 @@ docker run -it --rm \
 ## Tree-sitter Customization
 Tree-sitter turns source code into structural blocks used to generate FIM examples. Use this section to add new languages or build missing parsers.
 
-- [Add Language Definitions](docs/tree-sitter-customization.md#add-new-language-block-definitions): define `block_types` and `subblock_types` in JSON.
-- [Build Custom Parser](docs/tree-sitter-customization.md#build-custom-parser): compile a parser from source, for example for Mojo.
+- [Add Language Definitions](https://github.com/cuolm/codefinetuner/tree/master/docs/tree-sitter-customization.md#add-new-language-block-definitions): define `block_types` and `subblock_types` in JSON.
+- [Build Custom Parser](https://github.com/cuolm/codefinetuner/tree/master/docs/tree-sitter-customization.md#build-custom-parser): compile a parser from source, for example for Mojo.
 
 ## Tests
 Run the test suite with:
@@ -287,4 +287,4 @@ pytest
 - [llama.vscode](https://github.com/ggml-org/llama.vscode)
 
 ## License
-Licensed under the [Apache License 2.0](LICENSE.txt).
+Licensed under the [Apache License 2.0](https://github.com/cuolm/codefinetuner/tree/master/LICENSE.txt).

{codefinetuner-0.2.0 → codefinetuner-0.2.1}/README.md

@@ -69,15 +69,15 @@ Here is an example illustrating how a single FIM example is created:
   <tr>
     <td align="center" valign="top">
       <strong>Source Code File</strong><br>
-      <img src="docs/code_file.png" alt="code_file" width="250">
+      <img src="/docs/code_file.png" alt="code_file" width="250">
     </td>
     <td align="center" valign="top">
       <strong>Code Block</strong><br>
-      <img src="docs/code_block.png" alt="code_block" width="250">
+      <img src="/docs/code_block.png" alt="code_block" width="250">
     </td>
     <td align="center" valign="top">
       <strong>One Subblock</strong><br>
-      <img src="docs/code_subblock.png" alt="code_subblock" width="250">
+      <img src="/docs/code_subblock.png" alt="code_subblock" width="250">
     </td>
   </tr>
 </table>
@@ -141,7 +141,7 @@ globals: &globals
   data_extensions: [".c", ".h"]
 
 preprocess:
-  <<: *globals                   # Inherits all global parameters
+  <<: *globals  # inherits all global parameters
   split_mode: "manual"
   max_token_sequence_length: 1024
   # ... (preprocess specific settings)
@@ -233,8 +233,8 @@ docker run -it --rm \
 ## Tree-sitter Customization
 Tree-sitter turns source code into structural blocks used to generate FIM examples. Use this section to add new languages or build missing parsers.
 
-- [Add Language Definitions](docs/tree-sitter-customization.md#add-new-language-block-definitions): define `block_types` and `subblock_types` in JSON.
-- [Build Custom Parser](docs/tree-sitter-customization.md#build-custom-parser): compile a parser from source, for example for Mojo.
+- [Add Language Definitions](/docs/tree-sitter-customization.md#add-new-language-block-definitions): define `block_types` and `subblock_types` in JSON.
+- [Build Custom Parser](/docs/tree-sitter-customization.md#build-custom-parser): compile a parser from source, for example for Mojo.
 
 ## Tests
 Run the test suite with:
@@ -254,4 +254,4 @@ pytest
 - [llama.vscode](https://github.com/ggml-org/llama.vscode)
 
 ## License
-Licensed under the [Apache License 2.0](LICENSE.txt).
+Licensed under the [Apache License 2.0](/LICENSE.txt).

{codefinetuner-0.2.0 → codefinetuner-0.2.1}/pyproject.toml

@@ -1,12 +1,11 @@
 [build-system]
-requires = ["hatchling", "hatch-vcs"]  # hatch-vcs used to sync versioning with latest git tag number 
+requires = ["hatchling", "hatch-vcs", "hatch-fancy-pypi-readme"]  # hatch-vcs used to sync versioning with latest git tag number 
 build-backend = "hatchling.build"
 
 [project]
 name = "codefinetuner"
-dynamic = ["version"]
+dynamic = ["version", "readme"]
 description = "Add your description here"
-readme = "README.md"
 requires-python = ">=3.13"
 license = "Apache-2.0"
 license-files = ["LICEN[CS]E*"]
@@ -60,5 +59,21 @@ addopts = "--import-mode=importlib --ignore=third_party"  # importlib-based impo
 [tool.hatch.version]
 source = "vcs"
 
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
+path = "README.md"
+
+# RULE 1: Fixes [text](relative/path) links
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
+replacement = '[\1](https://github.com/cuolm/codefinetuner/tree/master\g<2>)'
+
+# RULE 2: Fixes <img src="docs/..."> tags
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = 'src="[\/]?docs\/(.+?)"'
+replacement = 'src="https://raw.githubusercontent.com/cuolm/codefinetuner/master/docs/\1"'
+
 [tool.hatch.build.targets.wheel]
 packages = ["src/codefinetuner"]