0.1.0 release

.github/workflows/documentation.yml → .github/workflows/build_and_publish_docs.yml

@@ -22,10 +22,10 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: set up python 3.9
+      - name: set up python '3.11'
         uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: '3.11'
 
       - uses: r-lib/actions/setup-pandoc@v2
         with:
@@ -35,16 +35,21 @@ jobs:
         run: |
           python -m pip install --upgrade pip poetry
           python -m poetry install --with docs --all-extras --no-ansi --no-interaction
+          # Explicitly install theme and its dependencies
+          python -m poetry run pip install pydata-sphinx-theme sphinx-copybutton
 
       - name: build documentation
-        env:
-          TG_BOT_TOKEN: ${{ secrets.TG_BOT_TOKEN }}
-          TG_BOT_USERNAME: ${{ secrets.TG_BOT_USERNAME }}
         run: |
-          python -m poetry run sphinx-build -M html docs/source/ docs/build/
+          # Force clean build
+          rm -rf docs/build/
+          python -m poetry run sphinx-build -b html -a -E docs/source/ docs/build/
 
-      - name: remove jekyll theming
-        run: touch docs/build/.nojekyll
+      - name: check build contents
+        run: |
+          echo "Checking build directory contents:"
+          ls -la docs/build/
+          echo "Checking for CSS files:"
+          find docs/build/ -name "*.css"
 
       - name: save branch name without slashes
         if: ${{ github.ref != 'refs/heads/master' }}
@@ -63,10 +68,26 @@ jobs:
           path: docs/build/
           retention-days: 3
 
-      - name: deploy website
+      - name: deploy website for master
         if: ${{ github.ref == 'refs/heads/master' }}
         uses: JamesIves/[email protected]
         with:
           branch: gh-pages
           folder: docs/build/
-          single-commit: True
+          target-folder: master # Deploy to root for master branch
+          single-commit: false
+          clean: True
+
+      - name: deploy website for dev
+        if: ${{ github.ref == 'refs/heads/dev' }}
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: docs/build/
+          target-folder: dev # Deploy to /dev subdirectory
+          single-commit: false # Keep history for dev branch
+          clean: True
+
+      - name: print link to the documentation
+        run: |
+          echo "https://deeppavlov.github.io/dialogue2graph/${{ github.head_ref || github.ref_name }}"

.github/workflows/build_and_publish_release.yml

@@ -0,0 +1,32 @@
+name: build_and_publish_release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: false
+
+      - name: Configure Poetry
+        run: |
+          poetry config pypi-token.pypi ${{ secrets.PYPI_API_TOKEN }}
+          poetry config http-basic.pypi __token__ ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Build and publish
+        run: |
+          poetry build
+          poetry publish

.github/workflows/codestyle.yml

@@ -21,10 +21,10 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: set up python 3.9
+      - name: set up python '3.11'
         uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: '3.11'
 
       - name: setup poetry and install dependencies
         run: |

.github/workflows/coverage.yml

@@ -0,0 +1,33 @@
+name: coverage
+
+on:
+  push:
+    branches: '**'
+  pull_request:
+    branches:
+    - dev
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/dev' && github.ref != 'refs/heads/master' }}
+
+jobs:
+  test_cov_ubuntu_latest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: set up python '3.11'
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: setup poetry and install dependencies
+        run: |
+          python -m pip install --upgrade pip poetry
+          python -m poetry install --with tests --no-ansi --no-interaction
+
+      - name: run tests
+        run: |
+          python -m poetry run poe coverage || exit 1

.github/workflows/test_release.yml

@@ -0,0 +1,51 @@
+name: test_release
+
+on:
+  push:
+    branches: '**'
+  pull_request:
+    branches:
+    - main
+  workflow_dispatch:
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: ${{ github.ref != 'refs/heads/dev' && github.ref != 'refs/heads/main' }}
+
+jobs:
+  test_full:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+        os: [macOS-latest, windows-latest, ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: setup poetry and install dependencies
+        run: |
+          python -m pip install --upgrade pip poetry==1.8.4
+
+      - name: build release
+        run: |
+          python -m poetry build
+
+      - name: install and test installed package
+        shell: bash
+        run: |
+          python -m venv test_env
+          . ${GITHUB_WORKSPACE}/test_env/bin/activate || . ${GITHUB_WORKSPACE}/test_env/Scripts/activate
+          pip install ./dist/*.whl
+          pip install pytest
+          # Debug information
+          echo "Current directory: $(pwd)"
+          echo "Directory contents:"
+          ls -la
+          # Actually run the tests with explicit path
+          python -m pytest tests/ -v

.github/workflows/tests.yml

@@ -0,0 +1,33 @@
+name: tests
+
+on:
+  push:
+    branches: '**'
+  pull_request:
+    branches:
+    - dev
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/dev' && github.ref != 'refs/heads/master' }}
+
+jobs:
+  test_ubuntu_latest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: set up python '3.11'
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: setup poetry and install dependencies
+        run: |
+          python -m pip install --upgrade pip poetry
+          python -m poetry install --with tests --no-ansi --no-interaction
+
+      - name: run tests
+        run: |
+          python -m poetry run poe test || exit 1

.gitignore

@@ -6,4 +6,13 @@ __pycache__
 *.egg-info
 *.png
 *.jpg
-*.jpeg
+*.jpeg
+.pytest_cache
+.mypy_cache
+test.ipynb
+*.pyc
+docs/build
+.ruff_cache
+.coverage
+htmlcov
+dist

CONTRIBUTING.md

@@ -1,58 +1,71 @@
-# Contributing to chatsky-llm-integration
+# Contributing to Dialogue2Graph
 
-Thank you for your interest in contributing to the dff-llm-integration project! We welcome contributions from the community to help improve and expand this Chatsky LLM-Autoconfig tool.
+Thank you for your interest in contributing to the Dialogue2Graph project! We welcome contributions from the community to help improve and expand Dialogue2Graph tool.
 
 ## Getting Started
 
-1. Create a branch for your work. Branch names should start with the goal they are created (`feat`, `fix` etc.)
-2. Checkout to your branch
+1. Create a branch for your work. Preferable branch prefixes are `feat`, `fix`, `exp`.
+2. Switch to your branch
+
 ```bash
 git checkout <your_branch_name>
 ```
-3. Set up the development environment:
+
+3. Set up the development environment (it is activated automatically)
+
 ```bash
 poetry install --with docs,lint,tests
 ```
-The environment will be activated automatically.
 
-If you want to delete all the virtual environments, run
+To delete all the virtual environments, run
+
 ```bash
 poetry env remove --all
 ```
 
 ## Updating Dependencies
 
-We use poetry.lock to ensure that all builds with the same lock file have the same 3rd-party library versions. This lets us know whether workflow fails due to our part or because a dependency update breaks something.
+We use poetry as a dependency management tool. `poetry.lock` contains all dependencies for the current project. In order to update versions specified in the `poetry.lock`, run
 
-In order to update versions specified in poetry.lock, run
 ```bash
 poetry update
 ```
 
 ## How to Contribute
-1. Make your changes and test hypothesis in the `./experiments` folder as it is described in **Conducting experiments** section
-2. Write if needed and run the tests from the `./tests` folder via
-```
-poetry run pytest tests/<your_tests_directory>
-```
-3. Ensure linting using commands as
-```
-poetry run poe lint
-poetry run poe format
-```
-4. Create a pull request with clear description of fixed and features
 
-## Pull Request format
-Please, include short description about your PR in it, give it a simple and inderstandable name.
-You can always create a draft PR and request review before you request to merge it into main repository.
+1. Experiment with the graphs (see the following section for a detail) or add new features to Dialogue2Graph tool
+
+2. Check linting and try to reformat your code running
+
+    ```bash
+    poetry run poe lint
+    poetry run poe format
+    ```
+
+3. Create a pull request
+
+**Tips:**
+
+- choose a proper name for your pull request,
+- add clear description of new features and fixes
 
-## Conducting experiments
-Until any of the code make it way to the main repo it should be tested in `./experiments` folder.
-Each of the experiments must lay in the separate folder with name like `<YYYY.MM.DD>_<experiment_name>`.
-Inside of this directory must be a `report.md` file with results, metrics, future plans and other relevant information.
+## Setting Experiments
 
-**!!! Do not put images into the folder you are commiting, use GoogleDrive instead !!!**
+All conducted experiments should be stored in the `./experiments` folder, each experiment saved in the separate folder and named standardly, `exp<YYYY>_<MM>_<DD>_<hypothesis>`.
 
+To make new experiment with automatic folder creation run
+
+```bash
+poetry new <experiment_name>
+```
+
+or, alternatively, if you've already created the folder, run
+
+```bash
+poetry init
+```
+
+**Note**: no images are allowed to put into folder. Please, consider using external links for attaching or using image files
 
 ## Coding Guidelines
 
@@ -61,9 +74,16 @@ Inside of this directory must be a `report.md` file with results, metrics, futur
 - Include docstrings for functions and classes
 - Write unit tests for new features or bug fixes
 
+## Pull Request Format
+
+- Name of your PR (keep it simple yet meaningful)
+- Short description (provide list of changes)
+
+When having any doubts, you can simply create a draft PR and request a review before merging your request.
+
 ## Reporting Issues
 
-If you encounter any bugs or have feature requests, please open an issue on the GitHub repository. Provide as much detail as possible, including:
+If you encounter any bugs or have feature requests, please, open an issue on the GitHub. Provide as much detail as possible, including:
 
 - A clear and descriptive title
 - Steps to reproduce the issue
@@ -73,14 +93,15 @@ If you encounter any bugs or have feature requests, please open an issue on the
 
 ## Current Focus Areas
 
-We are currently working on supporting various types of graphs. Here's the current status:
+We are currently working on supporting various types of graphs.
+
+Supported graph types:
 
-Supported types of graphs:
 - [x] chain
 - [x] single cycle
+- [x] multi-cycle graph
+- [x] complex graph with cycles
+
+Currently unsupported graph types:
 
-Currently unsupported types:
 - [ ] single node cycle
-- [ ] multi-cycle graph
-- [ ] incomplete graph
-- [ ] complex graph with cycles