diff --git a/pr-preview/pr-82/.doctrees/design.doctree b/pr-preview/pr-82/.doctrees/design.doctree index 756ab83..829c334 100644 Binary files a/pr-preview/pr-82/.doctrees/design.doctree and b/pr-preview/pr-82/.doctrees/design.doctree differ diff --git a/pr-preview/pr-82/.doctrees/development/index.doctree b/pr-preview/pr-82/.doctrees/development/index.doctree index b330e2b..c2ba4ff 100644 Binary files a/pr-preview/pr-82/.doctrees/development/index.doctree and b/pr-preview/pr-82/.doctrees/development/index.doctree differ diff --git a/pr-preview/pr-82/.doctrees/environment.pickle b/pr-preview/pr-82/.doctrees/environment.pickle index 9487b80..829d03e 100644 Binary files a/pr-preview/pr-82/.doctrees/environment.pickle and b/pr-preview/pr-82/.doctrees/environment.pickle differ diff --git a/pr-preview/pr-82/.doctrees/file-formats.doctree b/pr-preview/pr-82/.doctrees/file-formats.doctree index f1ba669..12d912a 100644 Binary files a/pr-preview/pr-82/.doctrees/file-formats.doctree and b/pr-preview/pr-82/.doctrees/file-formats.doctree differ diff --git a/pr-preview/pr-82/.doctrees/index.doctree b/pr-preview/pr-82/.doctrees/index.doctree index 31bfa8a..2bd7ff8 100644 Binary files a/pr-preview/pr-82/.doctrees/index.doctree and b/pr-preview/pr-82/.doctrees/index.doctree differ diff --git a/pr-preview/pr-82/design/index.html b/pr-preview/pr-82/design/index.html index c87fd25..0159ece 100644 --- a/pr-preview/pr-82/design/index.html +++ b/pr-preview/pr-82/design/index.html @@ -315,8 +315,8 @@

What other existing projects were considered? -
  • ``wagon``

  • -
  • ``conda-pack``

  • +
  • wagon

  • +
  • conda-pack

  • Similar to venvstacks, wagon aims to avoid needing to download Python packages on the target deployment system. However, it does @@ -347,13 +347,13 @@

    What other existing projects were considered?

    Why use python-build-standalone for the base runtimes?

    -

    The short answer to this question is “Because that’s what ``pdm`` uses, +

    The short answer to this question is “Because that’s what pdm uses, and venvstacks was already using pdm as its project management tool”.

    The longer answer is that there’s a genuinely strong alignment between the properties that the python-build-standalone maintainers aim to provide in their published binaries, and the characteristics that venvstacks needs in its base runtime layers.

    -

    Supporting additional base runtime layer providers (such as ``conda``) +

    Supporting additional base runtime layer providers (such as conda) could be a genuinely interesting capability, but there are no current plans to implement such a mechanism.

    diff --git a/pr-preview/pr-82/development/index.html b/pr-preview/pr-82/development/index.html index 0e9eb42..4f09e41 100644 --- a/pr-preview/pr-82/development/index.html +++ b/pr-preview/pr-82/development/index.html @@ -319,7 +319,7 @@

    Get the source code

    Development Environment

    In order to work on venvstacks, you need to install -``pdm``, ``tox``, ``tox-pdm``, and ``scriv`` +pdm, tox, tox-pdm, and scriv (everything else can be executed via tox environments).

    Given these tools, the default development environment can be set up and other commands executed as described below.

    @@ -352,7 +352,7 @@

    Running from the source tree

    Building Documentation

    -

    pip’s documentation is built using ``Sphinx``. The documentation is written +

    pip’s documentation is built using Sphinx. The documentation is written in reStructuredText.

    To build it locally, run:

    $ tox -e docs
    @@ -362,7 +362,7 @@ 

    Building Documentation

    Changelog Entries

    -

    The venvstacks changelog is managed with ``scriv``.

    +

    The venvstacks changelog is managed with scriv.

    All changes which may affect venvstacks users should be given a user facing changelog entry with scriv create.

    Entries are written in .rst format by default, so they @@ -382,8 +382,8 @@

    Changelog Entries

    Code consistency checks

    -

    The project source code is autoformatted and linted using ``ruff``. -It also uses ``mypy`` in strict mode to statically check that Python APIs +

    The project source code is autoformatted and linted using ruff. +It also uses mypy in strict mode to statically check that Python APIs are being accessed as expected.

    All of these commands can be invoked via tox:

    $ tox -e format
    @@ -410,8 +410,8 @@ 

    Code consistency checks

    Running tests locally

    -

    The project’s tests are written using the ``pytest`` test framework and the -standard library’s unittest module. ``tox`` is used to automate the +

    The project’s tests are written using the pytest test framework and the +standard library’s unittest module. tox is used to automate the setup and execution of these tests across multiple Python versions.

    Some of the tests build and deploy full environment stacks, which makes them take a long time to run (5+ minutes for the sample project build and export, diff --git a/pr-preview/pr-82/file-formats/index.html b/pr-preview/pr-82/file-formats/index.html index 96b9de6..254d850 100644 --- a/pr-preview/pr-82/file-formats/index.html +++ b/pr-preview/pr-82/file-formats/index.html @@ -402,7 +402,7 @@

    Common layer specification fields

    Runtime layer specifications must contain the following additional field:

      -
    • fully_versioned_name (string): the ``pbs-installer`` name +

    • fully_versioned_name (string): the pbs-installer name of the Python runtime to be installed as the base runtime for this layer (and any upper layers that depend on this layer).

    diff --git a/pr-preview/pr-82/index.html b/pr-preview/pr-82/index.html index 5e7273d..8cfd97d 100644 --- a/pr-preview/pr-82/index.html +++ b/pr-preview/pr-82/index.html @@ -321,7 +321,7 @@

    Virtual Environment StacksProject Overview for an example of specifying, locking, building, and publishing a set of environment stacks.

    venvstacks is available from the Python Package Index, -and can be installed with ``pipx`` (or similar tools):

    +and can be installed with pipx (or similar tools):

    $ pipx install venvstacks