move to src folder? (#137)

* move to src folder? * move to src folder? * move to src folder? * move to src folder? * move to src folder? * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * move to src folder? * move to src folder? * move to src folder? * move to src folder? * move to src folder? * move to src folder? * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
cvxgrp · Jan 10, 2025 · b8b6013 · b8b6013
1 parent ca47eaf
commit b8b6013
Show file tree

Hide file tree

Showing 22 changed files with 30 additions and 20 deletions.
diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml
@@ -12,33 +12,39 @@ jobs:
 
       - uses: cvxgrp/.github/actions/uv/[email protected]
 
-  sphinx:
+
+  test:
     runs-on: "ubuntu-latest"
     steps:
       - name: Checkout [${{ github.repository }}]
         uses: actions/checkout@v4
 
-      - uses: cvxgrp/.github/actions/uv/[email protected]
+      - uses: cvxgrp/.github/actions/uv/[email protected]
+        with:
+          source-folder: 'src/cvx'
+          tests-folder: 'src/tests'
 
-  test:
+  jupyter:
     runs-on: "ubuntu-latest"
     steps:
       - name: Checkout [${{ github.repository }}]
         uses: actions/checkout@v4
 
-      - uses: cvxgrp/.github/actions/uv/coverage@v2.0.0
+      - uses: cvxgrp/.github/actions/uv/jupyter@v2.0.0
 
-  jupyter:
-    runs-on: "ubuntu-latest"
+  pdoc:
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout [${{ github.repository }}]
         uses: actions/checkout@v4
 
-      - uses: cvxgrp/.github/actions/uv/[email protected]
+      - uses: cvxgrp/.github/actions/uv/[email protected]
+        with:
+          source-folder: 'src/cvx'
 
   book:
     runs-on: "ubuntu-latest"
-    needs: [test, sphinx, jupyter, marimo]
+    needs: [test, jupyter, marimo, pdoc]
 
     permissions:
       contents: write
@@ -47,4 +53,4 @@ jobs:
       - name: Checkout [${{ github.repository }}]
         uses: actions/checkout@v4
 
-      - uses: cvxgrp/.github/actions/[email protected].0
+      - uses: cvxgrp/.github/actions/[email protected].2
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -18,6 +18,7 @@ jobs:
       - name: Checkout [${{ github.repository }}]
         uses: actions/checkout@v4
 
-      - uses: cvxgrp/.github/actions/uv/[email protected].0
+      - uses: cvxgrp/.github/actions/uv/[email protected].2
         with:
           python-version: ${{ matrix.python-version }}
+          tests-folder: 'src/tests'
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -10,7 +10,10 @@ jobs:
       - name: Checkout [${{ github.repository }}]
         uses: actions/checkout@v4
 
-      - uses: cvxgrp/.github/actions/uv/[email protected]
+      - uses: cvxgrp/.github/actions/uv/[email protected]
+        with:
+          source-folder: 'src/cvx'
+          tests-folder: 'src/tests'
 
       - name: Coveralls GitHub Action
         uses: coverallsapp/github-action@v2
@@ -25,3 +28,5 @@ jobs:
         uses: actions/checkout@v4
 
       - uses: cvxgrp/.github/actions/uv/[email protected]
+        with:
+          source-folder: 'src/cvx'
diff --git a/README.md b/README.md
@@ -32,9 +32,9 @@ and encouraged.
 ```python
 import numpy as np
 
-from cvx.bson import read_bson, write_bson
+from src.cvx.bson import read_bson, write_bson
 
-data = {"A": np.random.rand(50,50), "B": np.random.rand(50)}
+data = {"A": np.random.rand(50, 50), "B": np.random.rand(50)}
 
 write_bson("test.bson", data)
 recovered = read_bson("test.bson")

diff --git a/book/docs/api.md b/book/docs/api.md
@@ -1,5 +1,3 @@
 # API
 
-## Sphinx
-
-[API](https://www.cvxgrp.org/cvxbson/sphinx/)
+[API](https://www.cvxgrp.org/cvxbson/pdoc/)
diff --git a/book/docs/index.md b/book/docs/index.md
@@ -33,9 +33,9 @@ and encouraged.
 ```python
 import numpy as np
 
-from cvx.bson import read_bson, write_bson
+from src.cvx.bson import read_bson, write_bson
 
-data = {"A": np.random.rand(50,50), "B": np.random.rand(50)}
+data = {"A": np.random.rand(50, 50), "B": np.random.rand(50)}
 
 write_bson("test.bson", data)
 recovered = read_bson("test.bson")

diff --git a/experiment/demo1.py b/experiment/demo1.py
@@ -3,7 +3,7 @@
 
 import polars as pl
 
-from cvx.bson.dataclass import Data
+from src.cvx.bson.dataclass import Data
 
 
 @dataclass(frozen=True)

diff --git a/pyproject.toml b/pyproject.toml
@@ -40,4 +40,4 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [tool.hatch.build.targets.wheel]
-packages = ["cvx"]
+packages = ["src/cvx"]
diff --git a/cvx/bson/__init__.py → src/cvx/bson/__init__.py b/cvx/bson/__init__.py → src/cvx/bson/__init__.py
diff --git a/cvx/bson/dataclass.py → src/cvx/bson/dataclass.py b/cvx/bson/dataclass.py → src/cvx/bson/dataclass.py
diff --git a/cvx/bson/file.py → src/cvx/bson/file.py b/cvx/bson/file.py → src/cvx/bson/file.py
diff --git a/cvx/bson/io.py → src/cvx/bson/io.py b/cvx/bson/io.py → src/cvx/bson/io.py
diff --git a/cvx/json/__init__.py → src/cvx/json/__init__.py b/cvx/json/__init__.py → src/cvx/json/__init__.py
diff --git a/cvx/json/file.py → src/cvx/json/file.py b/cvx/json/file.py → src/cvx/json/file.py
diff --git a/cvx/json/numpyencoder.py → src/cvx/json/numpyencoder.py b/cvx/json/numpyencoder.py → src/cvx/json/numpyencoder.py
diff --git a/tests/conftest.py → src/tests/conftest.py b/tests/conftest.py → src/tests/conftest.py
diff --git a/tests/resources/.gitkeep → src/tests/resources/.gitkeep b/tests/resources/.gitkeep → src/tests/resources/.gitkeep
diff --git a/tests/test_bson.py → src/tests/test_bson.py b/tests/test_bson.py → src/tests/test_bson.py
diff --git a/tests/test_dataclass.py → src/tests/test_dataclass.py b/tests/test_dataclass.py → src/tests/test_dataclass.py
diff --git a/tests/test_encode_decode.py → src/tests/test_encode_decode.py b/tests/test_encode_decode.py → src/tests/test_encode_decode.py
diff --git a/tests/test_json.py → src/tests/test_json.py b/tests/test_json.py → src/tests/test_json.py
diff --git a/tests/test_pandas.py → src/tests/test_pandas.py b/tests/test_pandas.py → src/tests/test_pandas.py