Merge pull request #114 from GangCaoLab/oxbow

Read files with oxbow

Author: Nanguage

.claude/settings.local.json

@@ -0,0 +1,12 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(python -m build:*)",
+      "Bash(python:*)",
+      "Bash(git rm:*)",
+      "Bash(make:*)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}

.github/workflows/docker-publish.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v4
         with:
           fetch-depth: 1
 

.github/workflows/docs.yml

@@ -0,0 +1,91 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - master
+      - oxbow  # Build docs for development branch as well
+    paths:
+      - 'docs/**'
+      - 'coolbox/**'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+      - 'coolbox/**'
+  workflow_dispatch:  # Allow manual trigger
+
+permissions:
+  contents: write  # Required for pushing to gh-pages branch
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch full history for version info
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y pandoc
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          # Install project with documentation dependencies
+          pip install -e ".[doc]"
+
+      - name: Build documentation
+        run: |
+          cd docs
+          # Clean old build artifacts if any
+          rm -rf build/
+          # Build documentation with Sphinx
+          sphinx-build -b html source build/html -W --keep-going
+          # Create .nojekyll file to tell GitHub Pages not to ignore underscore-prefixed directories
+          touch build/html/.nojekyll
+        env:
+          SPHINXOPTS: "-W --keep-going"
+
+      - name: Check documentation
+        run: |
+          cd docs/build/html
+          echo "Documentation build completed successfully!"
+          echo "Generated files:"
+          ls -lh
+          echo ""
+          echo "Total size:"
+          du -sh .
+
+      # Only deploy when pushing to master branch
+      - name: Deploy to GitHub Pages
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html
+          publish_branch: gh-pages
+          force_orphan: true  # Create orphan gh-pages branch without history
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          commit_message: 'Deploy documentation from ${{ github.sha }}'
+
+      - name: Upload documentation artifact
+        if: github.event_name == 'pull_request'
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: docs/build/html
+          retention-days: 7

.github/workflows/python-package-conda.yml

@@ -10,9 +10,9 @@ jobs:
       max-parallel: 5
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python 3.9
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: 3.9
     - name: Update Conda

.github/workflows/python-publish.yml

@@ -1,5 +1,5 @@
 # This workflow will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
 
 name: Upload Python Package
 
@@ -14,19 +14,21 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: '3.x'
-    - name: Install dependencies
+    - name: Install build dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
+        pip install build twine
+    - name: Build package
+      run: |
+        python -m build
+    - name: Publish to PyPI
       env:
         TWINE_USERNAME: __token__
         TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
       run: |
-        python setup.py sdist bdist_wheel
         twine upload dist/*

.gitignore

@@ -82,6 +82,15 @@ instance/
 
 # Sphinx documentation
 docs/build/
+# Sphinx generated HTML files in docs root (old structure)
+# These should now be built by CI/CD and not committed
+docs/*.html
+docs/*.js
+docs/_sources/
+docs/_static/
+docs/_images/
+docs/_gallery/
+docs/objects.inv
 
 # PyBuilder
 target/

coolbox/__init__.py

@@ -1 +1 @@
-__version__ = '0.3.9'
+__version__ = '0.4.0'

coolbox/__main__.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+
+from coolbox.cli import CLI
+import fire
+
+
+def main():
+    fire.Fire(CLI)
+
+
+if __name__ == "__main__":
+    main()

coolbox/core/browser/base.py

@@ -205,7 +205,9 @@ def preload_imgs(self, directions):
         Preloading images to self.fig_cache.
 
         Can load image in one of 4 directions:
-            left, right, zoom-in, zoom-out
+
+        - left, right, zoom-in, zoom-out
+
         or load all directions.
         """
 

coolbox/core/coverage/__init__.py

@@ -17,3 +17,10 @@
 HistCoverage = track_to_coverage(Hist)
 BigWigCoverage = track_to_coverage(BigWig)
 BedGraphCoverage = track_to_coverage(BedGraph)
+
+__all__ = [
+    "HighLights", "HighLightsFromFile", "Vlines", "VlinesFromFile", "HLines",
+    "TADCoverage", "ArcsCoverage", "PairsCoverage", "BEDPECoverage", "HiCPeaksCoverage",
+    "HistCoverage", "BigWigCoverage", "BedGraphCoverage",
+    "track_to_coverage", 
+]