Release version 0.0.0.dev425

pyproject.toml

@@ -17,7 +17,7 @@ namespaces = true
 # ----------------------------------------- Project Metadata -------------------------------------
 #
 [project]
-version = "0.0.0.dev424"
+version = "0.0.0.dev425"
 name = "ControlMan"
 dependencies = [
     "packaging >= 23.2, < 24",
@@ -27,18 +27,18 @@ dependencies = [
     "jsonpath-ng == 1.6.1",
     "ruamel.yaml == 0.18.6",
     "Jinja2 >= 3, < 4",
-    "PyLinks == 0.0.0.dev65",
-    "LoggerMan == 0.0.0.dev82",
-    "PySerials == 0.0.0.dev55",
-    "GitTidy == 0.0.0.dev80",
+    "PyLinks == 0.0.0.dev66",
+    "LoggerMan == 0.0.0.dev83",
+    "PySerials == 0.0.0.dev56",
+    "GitTidy == 0.0.0.dev81",
     "PkgData == 0.0.0.dev5",
-    "PyShellMan == 0.0.0.dev42",
+    "PyShellMan == 0.0.0.dev43",
     "PySyntax == 0.0.0.dev5",
-    "ExceptionMan == 0.0.0.dev52",
-    "MDit == 0.0.0.dev52",
-    "JSONSchemata == 0.0.0.dev51",
+    "ExceptionMan == 0.0.0.dev53",
+    "MDit == 0.0.0.dev53",
+    "JSONSchemata == 0.0.0.dev52",
     "VersionMan == 0.0.0.dev249",
     "HTMP == 0.0.0.dev5",
-    "LicenseMan == 0.0.0.dev39",
+    "LicenseMan == 0.0.0.dev40",
 ]
 requires-python = ">=3.10"

requirements.txt

@@ -5,16 +5,16 @@ referencing == 0.35.1
 jsonpath-ng == 1.6.1
 ruamel.yaml == 0.18.6
 Jinja2 >= 3, < 4
-PyLinks == 0.0.0.dev65
-LoggerMan == 0.0.0.dev82
-PySerials == 0.0.0.dev55
-GitTidy == 0.0.0.dev80
+PyLinks == 0.0.0.dev66
+LoggerMan == 0.0.0.dev83
+PySerials == 0.0.0.dev56
+GitTidy == 0.0.0.dev81
 PkgData == 0.0.0.dev5
-PyShellMan == 0.0.0.dev42
+PyShellMan == 0.0.0.dev43
 PySyntax == 0.0.0.dev5
-ExceptionMan == 0.0.0.dev52
-MDit == 0.0.0.dev52
-JSONSchemata == 0.0.0.dev51
+ExceptionMan == 0.0.0.dev53
+MDit == 0.0.0.dev53
+JSONSchemata == 0.0.0.dev52
 VersionMan == 0.0.0.dev249
 HTMP == 0.0.0.dev5
-LicenseMan == 0.0.0.dev39
+LicenseMan == 0.0.0.dev40

src/controlman/_data/schema/contributors.yaml

@@ -1,7 +1,11 @@
 $id: https://controlman.repodynamics.com/schema/contributors
 $schema: https://json-schema.org/draft/2020-12/schema
 title: Contributors
-description: Project's contributors.
+description: |
+  External contributors to the project.
+  
+  This corresponds to the [`contributors.json`] file in the project,
+  which is automatically maintained.
 type: object
 additionalProperties:
   $ref: https://controlman.repodynamics.com/schema/entity-def

src/controlman/_data/schema/def/dep-direct.yaml

@@ -0,0 +1,52 @@
+$id: https://controlman.repodynamics.com/schema/dep-direct
+$schema: https://json-schema.org/draft/2020-12/schema
+title: Package Dependency
+description: Definition of a package as a dependency.
+type: object
+allOf:
+  - $ref: https://controlman.repodynamics.com/schema/dep-indirect
+  - anyOf:
+      - required: [ conda ]
+      - required: [ pip ]
+    properties:
+      pip:
+        title: pip
+        description: Specifications for the `pip` package manager.
+        type: object
+        required: [ spec ]
+        properties:
+          spec:
+            type: string
+            description: |
+              Dependency specification for pip, according to 
+              [PEP 508](https://peps.python.org/pep-0508/#specification).
+              For more details, see
+              [Version Specifiers](https://packaging.python.org/en/latest/specifications/version-specifiers/#id5)
+              in PyPA's Python Packaging User Guide and
+              [Requirement Specifiers](https://pip.pypa.io/en/stable/reference/requirement-specifiers/)
+              in pip documentation.
+            examples:
+              - "numpy >= 1.21.2"
+      conda:
+        description: Specifications for the `conda` package manager.
+        type: object
+        required: [ spec, channel ]
+        properties:
+          spec:
+            description: |
+              Dependency specification for Conda, according to
+              [Conda Build](https://conda.io/projects/conda-build/en/stable/resources/package-spec.html#package-match-specifications).
+            examples:
+              - ">=1.21.2"
+            type: string
+          channel:
+            description: Anaconda channel where the package is available.
+            type: string
+            default: conda-forge
+            examples:
+              - anaconda
+              - my-channel
+          selector:
+            description: |
+              Line selector to apply to the dependency.
+            $ref: https://jsonschemata.repodynamics.com/string/oneline

src/controlman/_data/schema/def/entity-def.yaml

@@ -4,24 +4,24 @@ title: Entity Definition
 description: |
   Definition of a natural or legal person.
   
-  If `github.user` is provided, any of the following keys that is not explicitly provided
+  If [`github.user`](#ccdef-entity-def-github-user) is provided, any of the following keys that is not explicitly provided
   will be automatically filled with information retrieved from the
   [GitHub API](https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#get-a-user), if available
   (cf. [Personalizing your profile on GitHub](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile)):
-  - [`name`](#ccc-defs-entity-name)
-  - [`bio`](#ccc-defs-entity-bio)
-  - [`affiliation`](#ccc-defs-entity-affiliation)
-  - [`avatar`](#ccc-defs-entity-avatar)
-  - [`email`](#ccc-defs-entity-email)
-  - [`website`](#ccc-defs-entity-website)
-  - [`orcid`](#ccc-defs-entity-orcid)
-  - [`researchgate`](#ccc-defs-entity-researchgate)
-  - [`linkedin`](#ccc-defs-entity-linkedin)
-  - [`twitter`](#ccc-defs-entity-twitter)
-  - [`city`](#ccc-defs-entity-city)
-  - [`github.rest_id`](#ccc-defs-entity-github-rest_id)
-  - [`github.node_id`](#ccc-defs-entity-github-node_id)
-  - [`github.url`](#ccc-defs-entity-github-url)
+  - [`name`](#ccdef-entity-def-name)
+  - [`bio`](#ccdef-entity-def-bio)
+  - [`affiliation`](#ccdef-entity-def-affiliation)
+  - [`avatar`](#ccdef-entity-def-avatar)
+  - [`email`](#ccdef-entity-def-email)
+  - [`website`](#ccdef-entity-def-website)
+  - [`orcid`](#ccdef-entity-def-orcid)
+  - [`researchgate`](#ccdef-entity-def-researchgate)
+  - [`linkedin`](#ccdef-entity-def-linkedin)
+  - [`twitter`](#ccdef-entity-def-twitter)
+  - [`city`](#ccdef-entity-def-city)
+  - [`github.rest_id`](#ccdef-entity-def-github-rest_id)
+  - [`github.node_id`](#ccdef-entity-def-github-node_id)
+  - [`github.url`](#ccdef-entity-def-github-url)
 type: object
 additionalProperties: false
 properties:

src/controlman/_data/schema/def/entity-ids.yaml

@@ -19,11 +19,27 @@ items:
     - {id: some_member_id, member: true}
     - {id: some_contributor_id, member: false}
   oneOf:
-    - $ref: https://controlman.repodynamics.com/schema/member-id
-    - type: object
+    - title: ID Only
+      description: |
+        Member or contributor defined by their ID.
+        
+        As long as there is no conflict between member IDs and contributor IDs,
+        it is safe to use this format, omitting the person's membership status.
+      $ref: https://controlman.repodynamics.com/schema/member-id
+    - title: ID and Membership
+      description: |
+        Member or contributor defined by their ID and membership status.
+        
+        By specifying both the ID and membership satus of a person,
+        possible ID conflicts can be avoided.
+      type: object
       properties:
         id:
+          title: ID
+          description: Member or contributor ID of the person.
           $ref: https://controlman.repodynamics.com/schema/member-id
         member:
+          description: |
+            Whether the ID corresponds to a member ID defined in [`$.team`](#ccc-team).
           type: boolean
-          default: true
+          default: true

src/controlman/_data/schema/def/entity.yaml

@@ -1,7 +1,12 @@
 $id: https://controlman.repodynamics.com/schema/entity
 $schema: https://json-schema.org/draft/2020-12/schema
 title: Entity
-description: A team member or other natural or legal person.
+description: |
+  A team member or other natural or legal person.
+  
+  This can either be an [entity definition](#ccdef-entity-def)
+  or the ID of an entity already defined in [`$.team`](#ccc-team).
 oneOf:
-  - $ref: https://controlman.repodynamics.com/schema/entity-def
+  - title: Definition
+    $ref: https://controlman.repodynamics.com/schema/entity-def
   - $ref: https://controlman.repodynamics.com/schema/member-id

src/controlman/_data/schema/def/pkg.yaml

@@ -169,9 +169,9 @@ properties:
       These are:
       - `Development Status`: Based on the latest version tag on the branch. 
       - `License`: Based on [`license.id`](#ccc-license.id), for supported licenses. 
-      - `Operating System`: Based on the provided [`os`](#ccc-defs-pkg_config.os) configurations.
-      - `Programming Language`: Based on the provided [`python.version`](#ccc-defs-pkg_config.python.version.spec) configurations.
-      - `Typed`: Based on [`typed`](#ccc-defs-pkg_config.typed).
+      - `Operating System`: Based on the provided [`os`](#ccdef-pkg-os) configurations.
+      - `Programming Language`: Based on the provided [`python.version`](#ccdef-pkg-python-version-spec) configurations.
+      - `Typed`: Based on [`typed`](#ccdef-pkg-typed).
       Here you can add additional classifiers, such as `Topic` or `Intended Audience`.
       For a full list of classifiers, see the [PyPI classifiers list](https://pypi.org/classifiers/),
       or the [trove-classifiers](https://github.com/pypa/trove-classifiers/blob/main/src/trove_classifiers/__init__.py)
@@ -243,7 +243,9 @@ properties:
   authors:
     title: Authors
     description: |
-      Core authors of the package, ordered by contribution (highest first).
+      Core authors of the package.
+      
+      ordered by contribution (highest first).
       Authors are defined by their [team](#ccc-team)-member IDs.
 
       :::{admonition} Usage
@@ -258,12 +260,13 @@ properties:
     $ref: https://controlman.repodynamics.com/schema/entity-ids
     default: |
       #{{
-          return [
-            member["id"] for member in team_members_with_role_types(
-              "Author",
-              active_only=True,
-            )
-          ]
+        return [
+          {"id": int_author["id"], "member": True}
+          for int_author in team_members_with_role_types("Author", active_only=True)
+        ] + [
+          {"id"}: ext_author["id"], "member": False}
+          for ext_author in changelog.current_public.contributors_with_role_types("Author", member=False)
+        ]
       }}#
     examples:
       - ${{ citation.cff.authors }}$