⚠️ Migrate to Common Access Model

.copier-answers.yml

@@ -10,6 +10,5 @@ gh_action_pypi: false
 github_org: include-dcc
 license: MIT
 project_description: Internal Access model for the INCLUDE DCC.
-project_name: include-access-model
-project_slug: include_access_model
-
+project_name: common-access-model
+project_slug: common_access_model

.gitignore

@@ -3,8 +3,8 @@
 /docs/schema/*.yaml
 
 # generated pydantic model
-/src/include_access_model/datamodel/include_access_model_pydantic.py
-/src/include_access_model/datamodel/include_access_model.py
+/src/common_access_model/datamodel/common_access_model_pydantic.py
+/src/common_access_model/datamodel/common_access_model.py
 
 # linkml-run-examples output (not useful to have in git in its current form)
 /examples/output/

CONTRIBUTING.md

@@ -1,9 +1,9 @@
-# Contributing to include-access-model
+# Contributing to common-access-model
 
 :+1: First of all: Thank you for taking the time to contribute!
 
 The following is a set of guidelines for contributing to
-include-access-model. These guidelines are not strict rules.
+common-access-model. These guidelines are not strict rules.
 Use your best judgment, and feel free to propose changes to this document
 in a pull request.
 
@@ -22,7 +22,7 @@ in a pull request.
 
 ## Code of Conduct
 
-The include-access-model team strives to create a
+The common-access-model team strives to create a
 welcoming environment for editors, users and other contributors.
 Please carefully read our [Code of Conduct](CODE_OF_CONDUCT.md).
 
@@ -73,7 +73,7 @@ Please submit a [Pull Request][pulls] to submit a new term for consideration.
     - Never work on the main branch, always work on an issue/feature branch
     - Core developers can work on branches off origin rather than forks
     - Always create a PR on a branch to maximize transparency of what you are doing
-    - PRs should be reviewed and merged in a timely fashion by the include-access-model technical leads
+    - PRs should be reviewed and merged in a timely fashion by the common-access-model technical leads
     - PRs that do not pass GitHub actions should never be merged
     - In the case of git conflicts, the contributor should try and resolve the conflict
     - If a PR fails a GitHub action check, the contributor should try and resolve the issue in a timely fashion
@@ -115,7 +115,7 @@ Core developers should read the material on the [LinkML site](https://linkml.io/
 [about-branches]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches
 [about-issues]: https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues
 [about-pulls]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
-[issues]: https://github.com/include-dcc/include-access-model/issues/
-[pulls]: https://github.com/include-dcc/include-access-model/pulls/
+[issues]: https://github.com/include-dcc/common-access-model/issues/
+[pulls]: https://github.com/include-dcc/common-access-model/pulls/
 
 We recommend also reading [GitHub Pull Requests: 10 Tips to Know](https://blog.mergify.com/github-pull-requests-10-tips-to-know/)

README.md

@@ -1,12 +1,12 @@
 <a href="https://github.com/dalito/linkml-project-copier"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json" alt="Copier Badge" style="max-width:100%;"/></a>
 
-# include-access-model
+# common-access-model
 
-Internal Access model for the INCLUDE DCC.
+Common Access Model designed to support core data operations for cloud repositories.
 
 ## Documentation Website
 
-[https://include-dcc.github.io/include-access-model](https://include-dcc.github.io/include-access-model)
+[https://include-dcc.github.io/common-access-model](https://include-dcc.github.io/common-access-model)
 
 ## Repository Structure
 
@@ -15,10 +15,10 @@ Internal Access model for the INCLUDE DCC.
 * [examples/](examples/) - Examples of using the schema
 * [project/](project/) - project files (these files are auto-generated, do not edit)
 * [src/](src/) - source files (edit these)
-  * [include_access_model](src/include_access_model)
-    * [schema/](src/include_access_model/schema) -- LinkML schema
+  * [common_access_model](src/common_access_model)
+    * [schema/](src/common_access_model/schema) -- LinkML schema
       (edit this)
-    * [datamodel/](src/include_access_model/datamodel) -- generated
+    * [datamodel/](src/common_access_model/datamodel) -- generated
       Python datamodel
 * [tests/](tests/) - Python tests
   * [data/](tests/data) - Example data

config.public.mk

@@ -6,10 +6,10 @@
 
 # Note:
 # - just works fine with quoted variables of dot-env files like this one
-LINKML_SCHEMA_NAME="include_access_model"
+LINKML_SCHEMA_NAME="common_access_model"
 LINKML_SCHEMA_AUTHOR="Robert Carroll <robert.carroll@vumc.org>"
 LINKML_SCHEMA_DESCRIPTION="Internal Access model for the INCLUDE DCC."
-LINKML_SCHEMA_SOURCE_DIR="src/include_access_model/schema"
+LINKML_SCHEMA_SOURCE_DIR="src/common_access_model/schema"
 
 ###### linkml generator variables, used by justfile
 

docs/about.md

@@ -1,3 +1,3 @@
-# About include-access-model
+# About common-access-model
 
 Internal Access model for the INCLUDE DCC.

docs/index.md

@@ -1,4 +1,4 @@
-# include-access-model
+# common-access-model
 
 Internal Access model for the INCLUDE DCC.
 

examples/README.md

@@ -1,4 +1,4 @@
-# Examples of using include-access-model
+# Examples of using common-access-model
 
 This folder contains examples using the datamodel.
 

mkdocs.yml

@@ -1,5 +1,5 @@
 ---
-site_name: "include-access-model"
+site_name: "common-access-model"
 theme:
   name: material
   # palette:
@@ -22,7 +22,7 @@ plugins:
   #       - gen_pages.py  # or any other name or path
 
 watch:
-  - src/include_access_model/schema
+  - src/common_access_model/schema
 
 nav:
 #  - Home: index.md
@@ -33,8 +33,8 @@ nav:
 exclude_docs: |
   /templates-linkml/
 
-site_url: https://include-dcc.github.io/include-access-model
-repo_url: https://github.com/include-dcc/include-access-model
+site_url: https://include-dcc.github.io/common-access-model
+repo_url: https://github.com/include-dcc/common-access-model
 
 # Uncomment this block to enable use of Google Analytics.
 # Replace the property value with your own ID.

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["hatchling", "uv-dynamic-versioning"]
 build-backend = "hatchling.build"
 
 [project]
-name = "include_access_model"
+name = "common_access_model"
 description = "Internal Access model for the INCLUDE DCC."
 authors = [
   {name = "Robert Carroll", email = "robert.carroll@vumc.org"},
@@ -51,8 +51,8 @@ skip = [
   "pyproject.toml",
   "uv.lock",
   "project/*",
-  "src/include_access_model/datamodel/include_access_model_pydantic.py",
-  "src/include_access_model/datamodel/include_access_model.py",
+  "src/common_access_model/datamodel/common_access_model_pydantic.py",
+  "src/common_access_model/datamodel/common_access_model.py",
 ]
 
 # Reminder: words have to be lowercased for the ignore-words-list
@@ -68,6 +68,6 @@ extend-exclude = [
   "uv.lock",
   "pyproject.toml",
   "project/*",
-  "src/include_access_model/datamodel/include_access_model_pydantic.py",
-  "src/include_access_model/datamodel/include_access_model.py",
+  "src/common_access_model/datamodel/common_access_model_pydantic.py",
+  "src/common_access_model/datamodel/common_access_model.py",
 ]

src/include_access_model/__init__.py → src/common_access_model/__init__.py

@@ -1,5 +1,5 @@
 try:
-    from include_access_model._version import __version__, __version_tuple__
+    from common_access_model._version import __version__, __version_tuple__
 except ImportError:  # pragma: no cover
     __version__ = "0.0.0"
     __version_tuple__ = (0, 0, 0)

src/include_access_model/datamodel/__init__.py → src/common_access_model/datamodel/__init__.py

@@ -1,7 +1,7 @@
 from pathlib import Path
-from .include_access_model import *
+from .common_access_model import *
 
 THIS_PATH = Path(__file__).parent
 
 SCHEMA_DIRECTORY = THIS_PATH.parent / "schema"
-MAIN_SCHEMA_PATH = SCHEMA_DIRECTORY / "include_access_model.yaml"
+MAIN_SCHEMA_PATH = SCHEMA_DIRECTORY / "common_access_model.yaml"