datachain 0.1.12__tar.gz → 0.2.0__tar.gz

{datachain-0.1.12 → datachain-0.2.0}/.cruft.json

@@ -13,7 +13,7 @@
       "version": "0.0.0",
       "copyright_year": "2022",
       "license": "Apache-2.0",
-      "docs": "False",
+      "docs": true,
       "short_description": "Wrangle unstructured AI data at scale",
       "development_status": "Development Status :: 2 - Pre-Alpha",
       "_template": "https://github.com/iterative/py-template"

datachain-0.2.0/.github/workflows/docs.yml

@@ -0,0 +1,34 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+
+      - name: Install uv
+        run: python -m pip install --upgrade uv
+
+      - name: Configure git
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+
+      - name: Publish docs
+        run: |
+          uv pip install '.[docs]' --system
+          mkdocs gh-deploy

{datachain-0.1.12 → datachain-0.2.0}/.github/workflows/tests.yml

@@ -122,3 +122,6 @@ jobs:
 
       - name: Build package
         run: nox -s build
+
+      - name: Build docs
+        run: nox -s docs

{datachain-0.1.12 → datachain-0.2.0}/.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
       - id: trailing-whitespace
         exclude: '^LICENSES/'
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.4.9'
+    rev: 'v0.5.0'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

{datachain-0.1.12 → datachain-0.2.0}/CONTRIBUTING.rst

@@ -8,11 +8,13 @@ welcomes contributions in the form of bug reports, feature requests, and pull re
 Here is a list of important resources for contributors:
 
 - `Source Code`_
+- `Documentation`_
 - `Issue Tracker`_
 - `Code of Conduct`_
 
 .. _Apache 2.0 license: https://opensource.org/licenses/Apache-2.0
 .. _Source Code: https://github.com/iterative/dvcx
+.. _Documentation: https://docs.dvc.ai/datachain
 .. _Issue Tracker: https://github.com/iterative/dvcx/issues
 
 How to report a bug
@@ -82,6 +84,24 @@ and are written using the pytest_ testing framework.
 .. _pytest: https://pytest.readthedocs.io/
 
 
+Build documentation
+-------------------
+
+If you've made any changes to the documentation (including changes to function signatures,
+class definitions, or docstrings that will appear in the API documentation),
+make sure it builds successfully.
+
+.. code:: console
+
+   $ nox -s docs
+
+In order to run this locally with hot reload on changes:
+
+.. code:: console
+
+   $ mkdocs serve
+
+
 How to submit changes
 ---------------------
 

{datachain-0.1.12/src/datachain.egg-info → datachain-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datachain
-Version: 0.1.12
+Version: 0.2.0
 Summary: Wrangle unstructured AI data at scale
 Author-email: Dmitry Petrov <support@dvc.org>
 License: Apache-2.0
@@ -38,6 +38,13 @@ Requires-Dist: ujson>=5.9.0
 Requires-Dist: pydantic<3,>=2
 Requires-Dist: jmespath>=1.0
 Requires-Dist: datamodel-code-generator>=0.25
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5.2; extra == "docs"
+Requires-Dist: mkdocs-gen-files>=0.5.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.3.1; extra == "docs"
+Requires-Dist: mkdocs-section-index>=0.3.6; extra == "docs"
+Requires-Dist: mkdocstrings-python>=1.6.3; extra == "docs"
+Requires-Dist: mkdocs-literate-nav>=0.6.1; extra == "docs"
 Provides-Extra: cv
 Requires-Dist: Pillow<11,>=10.0.0; extra == "cv"
 Requires-Dist: torch>=2.1.0; extra == "cv"
@@ -67,8 +74,8 @@ Requires-Dist: open_clip_torch; extra == "tests"
 Requires-Dist: aiotools>=1.7.0; extra == "tests"
 Requires-Dist: requests-mock; extra == "tests"
 Provides-Extra: dev
-Requires-Dist: datachain[tests]; extra == "dev"
-Requires-Dist: mypy==1.10.0; extra == "dev"
+Requires-Dist: datachain[docs,tests]; extra == "dev"
+Requires-Dist: mypy==1.10.1; extra == "dev"
 Requires-Dist: types-python-dateutil; extra == "dev"
 Requires-Dist: types-PyYAML; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"

datachain-0.2.0/docs/index.md

@@ -0,0 +1,3 @@
+# Welcome to DataChain
+
+- [API Reference](./references/datachain.md)

datachain-0.2.0/docs/references/catalog.md

@@ -0,0 +1,3 @@
+# `Catalog`
+
+::: datachain.catalog.Catalog

datachain-0.2.0/docs/references/datachain.md

@@ -0,0 +1,3 @@
+# `DataChain`
+
+::: datachain.lib.dc.DataChain

datachain-0.2.0/examples/computer_vision/fashion_product_images/.gitignore

@@ -0,0 +1,4 @@
+.datachain
+data
+dev
+test-notebooks.sh