Postmortem for 0.1.0 (#6)

.github/workflows/ci.yml

@@ -29,6 +29,8 @@ jobs:
       matrix:
         os: [ubuntu]
         python-version: ["3.11"]
+    outputs:
+      wheel: ${{ steps.wheel.outputs.wheel }}
     steps:
       - uses: actions/checkout@v3
 
@@ -71,11 +73,15 @@ jobs:
         run: doit list --all --status | sort
         if: always()
 
-      - name: Upload (dist)
+      - name: upload (dist)
         uses: actions/upload-artifact@v3
         with:
           name: doitoml-dist-${{ github.run_number }}
           path: ./dist
+      - id: wheel
+        name: get wheel name
+        run: |
+          echo "wheel=$(ls dist/*.whl)" >> $GITHUB_OUTPUT
 
   docs:
     name: docs
@@ -129,7 +135,7 @@ jobs:
         os: ["ubuntu", "macos", "windows"]
         python-version: ["3.8", "3.11"]
     env:
-      SKIP_CODEGEN: 1
+      DOITOML_SKIP_CODEGEN: 1
     steps:
       - name: configure line endings
         run: |
@@ -188,3 +194,36 @@ jobs:
       - name: Rename uncached conda packages
         shell: bash
         run: mv "${CONDA_PKGS_DIR}" "${CONDA_PKGS_DIR}_do_not_cache"
+
+  smoke:
+    runs-on: ${{ matrix.os }}-latest
+    needs: [build]
+    name: smoke (${{ matrix.os }} ${{ matrix.python-version }})
+    strategy:
+      max-parallel: 2
+      fail-fast: false
+      matrix:
+        os: ["ubuntu", "macos", "windows"]
+        python-version: ["3.11"]
+    steps:
+      - name: download (dist)
+        uses: actions/download-artifact@v3
+        with:
+          name: doitoml-dist-${{ github.run_number }}
+          path: ./dist
+
+      - name: setup (python)
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+
+      - name: install dist
+        run: |
+          ls "${{ needs.build.outputs.wheel }}" || dir "${{ needs.build.outputs.wheel }}"
+          pip install -vv "${{ needs.build.outputs.wheel }}"
+          pip check
+
+      - name: cli smoke test
+        run: |
+          python -c "__import__('doitoml')"

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.1.1
+
+- fix schema import
+
 ## 0.1.0
 
 - initial release

README.md

@@ -2,34 +2,51 @@
 
 > Load declarative tasks for [doit] from TOML, JSON, YAML, and other files.
 
+|            docs             |                                          install                                           |                build                 |
+| :-------------------------: | :----------------------------------------------------------------------------------------: | :----------------------------------: |
+| [![docs][docs-badge]][docs] | [![install from pypi][pypi-badge]][pypi] [![install from conda-forge][conda-badge]][conda] | [![build][workflow-badge]][workflow] |
+
+> See the [full documentation][docs] for more information.
+
 ## Install
 
-> > **TBD** for now, see the [contributing guide] for a development install.
->
-> |         `pip`         |   `conda` (or `mamba`, `micromamba`)   |
-> | :-------------------: | :------------------------------------: |
-> | `pip install doitoml` | `conda install -c conda-forge doitoml` |
+|         `pip`         |   `conda` (or `mamba`, `micromamba`)   |
+| :-------------------: | :------------------------------------: |
+| `pip install doitoml` | `conda install -c conda-forge doitoml` |
 
 ## Features
 
 - **declarative** automation in a **single** `pyproject.toml`, or...
-  - well-known configuration paths like `package.json`
-  - any number of namespaced TOML, JSON, or YAML files
+  - other well-known configuration paths like `package.json`
+  - any number of namespaced TOML, JSON, [YAML](#extras) files
     - from any key inside them
   - augment and simplify existing `dodo.py` workflows
 - reuse and transform **paths** and shell tokens
   - use **globs** and transforms to capture relationships between transformed files
 - flexibly configure **environment** variables
-- use **templates** like Jinja2 and JSON-e for advanced use cases
 - user-defined Python-based **actions** and **up-to-date** checkers
 - control the **working directory** and **log paths** of processes and actions
+- use [**templates**](#extras) like Jinja2 and JSON-e for advanced use cases
 - **extensibility** in any part of the task definition process
   - all core functionality implemented as `entry_point`-based **plugins**
 
+### Extras
+
+These features require additional `pip` or `conda` packages
+
+|                 `pip` | `conda`                   | feature                        |
+| --------------------: | ------------------------- | ------------------------------ |
+|        `doitoml[all]` | `doitoml-with-all`        | all optional features          |
+|     `doitoml[jinja2]` | `doitoml-with-jinja2`     | Jinja2 task templates          |
+|     `doitoml[json-e]` | `doitoml-with-json-e`     | JSON-e task templates          |
+| `doitoml[jsonschema]` | `doitoml-with-jsonschema` | extra configuration validation |
+|       `doitoml[yaml]` | `doitoml-with-yaml`       | YAML-based task sources        |
+
 ## Usage
 
 `doitoml` provides no additional command line abilities, and is meant to drop in to the
-existing `doit` CLI.
+existing [`doit run`](https://pydoit.org/cmd-run.html) CLI and
+[other commands](https://pydoit.org/cmd-other.html).
 
 ### A Simple Example
 
@@ -97,3 +114,12 @@ do everything _The Hard Way_:
 [docs]: https://doitoml.rtfd.io
 [doit]: https://github.com/pydoit/doit
 [github]: https://github.com/deathbeds/doitoml
+[docs-badge]: https://readthedocs.org/projects/doitoml/badge/?version=latest
+[conda-badge]: https://img.shields.io/conda/vn/conda-forge/doitoml
+[conda]: https://anaconda.org/conda-forge/doitoml
+[pypi-badge]: https://img.shields.io/pypi/v/doitoml
+[pypi]: https://pypi.org/project/doitoml
+[workflow-badge]:
+  https://github.com/deathbeds/doitoml/actions/workflows/ci.yml/badge.svg?branch=main
+[workflow]:
+  https://github.com/deathbeds/doitoml/actions/workflows/ci.yml?query=branch%3Amain

docs/conf.py

@@ -117,6 +117,12 @@ def transform_add_class(self: Any, schema: Any) -> Tuple[Any, Any]:
             "url": PROJ_DATA["project"]["urls"]["PyPI"],
             "icon": "fa-brands fa-python",
         },
+        {
+            "name": "conda-forge",
+            "url": "https://github.com/conda-forge/doitoml-feedstock#about-doitoml",
+            "icon": "_static/img/anvil.svg",
+            "type": "local",
+        },
     ],
     "footer_end": ["mermaid10"],
 }

docs/reference/api.md

@@ -23,7 +23,7 @@
 
 ```{eval-rst}
 .. currentmodule:: doitoml
-.. automodule:: doitoml.schema
+.. automodule:: doitoml.schema.validator
 ```
 
 ### Schema Types

docs/reference/schema.md

@@ -1,5 +1,5 @@
 # Schema
 
 ```{eval-rst}
-.. jsonschema:: doitoml.schema.DOITOML_SCHEMA
+.. jsonschema:: doitoml.schema.validator.DOITOML_SCHEMA
 ```

examples/py-js-web/.gitignore

@@ -8,3 +8,5 @@ dist
 lib
 node_modules
 static
+# a real project _would_ check this ins
+yarn.lock

examples/py-js-web/environment.yml

@@ -10,7 +10,7 @@ dependencies:
   # build
   - flit
   - python-build
-  - yarn >=3,<4
+  - yarn ==3.5
   # test
   - pytest-cov
   - pytest-html

examples/py-js-web/package.json

@@ -16,7 +16,8 @@
   "doitoml": {
     "env": {
       "EXAMPLE_JS_VERSION": ":get::json::package.json::version",
-      "EXAMPLE_JS_DIST": "deathbeds-example-frontend-${EXAMPLE_JS_VERSION}.tgz"
+      "EXAMPLE_JS_DIST": "deathbeds-example-frontend-${EXAMPLE_JS_VERSION}.tgz",
+      "YARN_ENABLE_IMMUTABLE_INSTALLS": "false"
     },
     "prefix": "frontend",
     "paths": {
@@ -70,10 +71,11 @@
         ],
         "file_dep": [
           "::backend::venv_history",
-          "::y_lock"
+          "::pj"
         ],
         "targets": [
-          "::y_install_state"
+          "::y_install_state",
+          "::y_lock"
         ],
         "actions": [
           [

examples/py-js-web/pyproject.toml

@@ -104,8 +104,8 @@ file_dep = ["::all_dist"]
 targets = ["::dist_hash"]
 
 [tool.__doitoml_tests__.steps.00_list]
-after = {files = {"*" = 10}}
-before = {files = {"**/*" = 17, "*" = 10}}
+after = {files = {"*" = 9}}
+before = {files = {"**/*" = 16, "*" = 9}}
 rc = 0
 run = ["doit", "list"]
 tasks = 10
@@ -117,6 +117,7 @@ run = ["doit"]
 
 [tool.__doitoml_tests__.steps.01_run.after.files]
 "*" = 12
+"yarn.lock" = 1
 "dist/*.tar.gz" = 1
 "dist/*.whl" = 1
 "dist/SHA256SUMS" = 1