Merge pull request #15 from marioernestovaldes/dev

Merge dev with main branch

Author: marioernestovaldes

.github/workflows/pytest.yml

@@ -0,0 +1,23 @@
+name: Run Tests
+
+on:
+  pull_request:
+  push:
+    branches: [ main, master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install .
+          pip install pytest pytest-cov
+      - name: Run tests
+        run: pytest --cov=dynamicviz --cov-report=xml --cov-report=term

AGENTS.md

@@ -0,0 +1,20 @@
+# Contributor Guide
+
+## Dev Environment Tips  
+- Use `uv venv` …  
+- Run `uv pip install -r requirements.txt` …  
+- Format code with `black .` and lint using `ruff check .`.  
+- Run all tests using `pytest`, or filter by test name with `pytest -k "<test_name>"`.  
+- Generate a coverage report with `pytest --cov=your_package_name --cov-report=term-missing`.  
+- Use `mypy` to perform static type checks if configured.  
+- Follow the project layout, and mirror test structure in `tests/` for clarity.
+
+## Testing Instructions
+- Find the CI plan in the .github/workflows folder.
+- Run every check defined for that package.
+- The commit should pass all tests before you merge.
+- Fix any test or type errors until the whole suite is green.
+- Add or update tests for the code you change, even if nobody asked.
+
+## PR instructions
+Title format: [<project_name>] <Title>

dynamicviz/__init__.py

@@ -1,3 +1,3 @@
-'''DynamicViz provides a wrapper for generating and interpreting dynamic visualizations from traditional static dimensionality reduction visualization methods'''
+"""DynamicViz provides a wrapper for generating and interpreting dynamic visualizations from traditional static dimensionality reduction visualization methods"""
 
-__version__ = "1.0.1"
+__version__ = "1.0.1"