Skip to content

Commit ba46e42

Browse files
RobertJCarrollRobertJCarroll
committed
Initialise git with minimal project
0 parents  commit ba46e42

35 files changed

+5025
-0
lines changed

‎.copier-answers.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Changes here will be overwritten by Copier
2+
_commit: v0.4.1
3+
_src_path: https://github.com/linkml/linkml-project-copier
4+
add_example: false
5+
copyright_year: '2025'
6+
email: [email protected]
7+
full_name: Robert Carroll
8+
gh_action_docs_preview: true
9+
gh_action_pypi: false
10+
github_org: include-dcc
11+
license: MIT
12+
project_description: Internal Access model for the INCLUDE DCC.
13+
project_name: include-access-model
14+
project_slug: include_access_model
15+

‎.editorconfig‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Check http://editorconfig.org for more information
2+
# This is the main config file for this project:
3+
root = true
4+
5+
[*]
6+
charset = utf-8
7+
end_of_line = lf
8+
insert_final_newline = true
9+
indent_style = space
10+
indent_size = 2
11+
trim_trailing_whitespace = true
12+
13+
[*.py]
14+
indent_style = space
15+
indent_size = 4
16+
17+
[*.md]
18+
trim_trailing_whitespace = false

‎.github/dependabot.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Please see the documentation for all configuration options:
2+
# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference
3+
4+
version: 2
5+
updates:
6+
- package-ecosystem: github-actions
7+
directory: "/"
8+
schedule:
9+
interval: monthly

‎.github/workflows/deploy-docs.yaml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: Deploy docs
3+
on: # yamllint disable-line rule:truthy
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions: {}
9+
10+
jobs:
11+
build-docs:
12+
runs-on: ubuntu-latest
13+
14+
# Grant GITHUB_TOKEN the permissions required to make a gh-pages deployment
15+
permissions:
16+
contents: write # to let mkdocs write the new docs
17+
pages: write # to deploy to Pages
18+
id-token: write # allow to generate an OpenID Connect (OIDC) token
19+
20+
steps:
21+
# https://github.com/actions/checkout
22+
- name: Checkout
23+
uses: actions/[email protected]
24+
with:
25+
fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
26+
27+
- name: Configure git for the bot
28+
# Gives the bot that commits to gh-pages a name & email address
29+
# so that the commits have an author in the commit log.
30+
run: |
31+
git config user.name github-actions[bot]
32+
git config user.email github-actions[bot]@users.noreply.github.com
33+
34+
# https://github.com/astral-sh/setup-uv
35+
- name: Install uv
36+
uses: astral-sh/[email protected]
37+
with:
38+
python-version: 3.13
39+
enable-cache: true
40+
cache-dependency-glob: "uv.lock"
41+
42+
# https://github.com/actions/setup-python
43+
- name: Set up Python
44+
uses: actions/[email protected]
45+
with:
46+
python-version: 3.13
47+
48+
- name: Install just
49+
run: |
50+
uv tool install rust-just
51+
52+
- name: Install dependencies
53+
run: uv sync --dev --no-progress
54+
55+
- name: Generate schema documentation
56+
run: |
57+
just gen-doc
58+
uv run mkdocs gh-deploy

‎.github/workflows/main.yaml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Built from:
2+
# https://docs.github.com/en/actions/guides/building-and-testing-python
3+
---
4+
name: Build and test
5+
6+
on: # yamllint disable-line rule:truthy
7+
push:
8+
branches: [main]
9+
pull_request:
10+
11+
env:
12+
FORCE_COLOR: "1" # Make tools pretty.
13+
14+
permissions: {}
15+
16+
jobs:
17+
test:
18+
19+
runs-on: ubuntu-latest
20+
strategy:
21+
matrix:
22+
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
23+
fail-fast: false
24+
25+
steps:
26+
27+
# https://github.com/actions/checkout
28+
- name: Check out repository
29+
uses: actions/[email protected]
30+
with:
31+
persist-credentials: false
32+
33+
# https://github.com/astral-sh/setup-uv
34+
- name: Install uv
35+
uses: astral-sh/[email protected]
36+
with:
37+
python-version: ${{ matrix.python-version }}
38+
enable-cache: true
39+
cache-dependency-glob: "uv.lock"
40+
41+
# https://github.com/actions/setup-python
42+
- name: Set up Python ${{ matrix.python-version }}
43+
uses: actions/[email protected]
44+
with:
45+
python-version: ${{ matrix.python-version }}
46+
47+
- name: Install just
48+
run: |
49+
uv tool install rust-just
50+
51+
- name: Install project
52+
run: uv sync --dev
53+
54+
- name: Run test suite
55+
run: just test

‎.github/workflows/test_pages_build.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Preview documentation build
2+
3+
on: # yamllint disable-line rule:truthy
4+
pull_request:
5+
types:
6+
- opened
7+
- reopened
8+
- synchronize
9+
10+
env:
11+
CLICOLOR: 1
12+
13+
concurrency: preview-${{ github.ref }}
14+
15+
permissions: {}
16+
17+
jobs:
18+
run:
19+
# Grant GITHUB_TOKEN the permissions required to make a gh-pages deployment
20+
permissions:
21+
contents: write # to let mkdocs write the new docs
22+
pages: write # to deploy to Pages
23+
id-token: write # allow to generate an OpenID Connect (OIDC) token
24+
pull-requests: write # add comment on the PR with the preview URL
25+
runs-on: ubuntu-latest
26+
steps:
27+
# https://github.com/actions/checkout
28+
- name: Checkout
29+
uses: actions/[email protected]
30+
with:
31+
fetch-depth: 0
32+
33+
# https://github.com/astral-sh/setup-uv
34+
- name: Install uv
35+
uses: astral-sh/[email protected]
36+
with:
37+
python-version: 3.13
38+
enable-cache: true
39+
cache-dependency-glob: "uv.lock"
40+
41+
# https://github.com/actions/setup-python
42+
- name: Set up Python 3
43+
uses: actions/[email protected]
44+
with:
45+
python-version: 3.13
46+
47+
- name: Install dependencies
48+
run: uv sync --dev --no-progress
49+
50+
- name: Build documentation
51+
run: |
52+
uv run mkdocs build -d site
53+
touch site/.nojekyll
54+
55+
# https://github.com/rossjrw/pr-preview-action
56+
- name: Deploy preview
57+
uses: rossjrw/[email protected]
58+
with:
59+
source-dir: site/
60+
preview-branch: gh-pages

‎.gitignore‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
# generated part of documentation
2+
/docs/elements/*.md
3+
# linkml-run-examples output (not useful to have in git in its current form)
4+
/examples/output/
5+
6+
# Derived schemas, generated from the schema.yaml
7+
tmp/
8+
project/
9+
!project/README.md
10+
11+
# Byte-compiled / optimized / DLL files
12+
__pycache__/
13+
*.py[cod]
14+
*$py.class
15+
16+
# C extensions
17+
*.so
18+
19+
# Distribution / packaging
20+
.Python
21+
build/
22+
develop-eggs/
23+
dist/
24+
downloads/
25+
eggs/
26+
.eggs/
27+
lib/
28+
lib64/
29+
parts/
30+
sdist/
31+
var/
32+
wheels/
33+
pip-wheel-metadata/
34+
share/python-wheels/
35+
*.egg-info/
36+
.installed.cfg
37+
*.egg
38+
MANIFEST
39+
40+
# PyInstaller
41+
# Usually these files are written by a python script from a template
42+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
43+
*.manifest
44+
*.spec
45+
46+
# Installer logs
47+
pip-log.txt
48+
pip-delete-this-directory.txt
49+
50+
# Unit test / coverage reports
51+
htmlcov/
52+
.tox/
53+
.nox/
54+
.coverage
55+
.coverage.*
56+
.cache
57+
nosetests.xml
58+
coverage.xml
59+
*.cover
60+
*.py,cover
61+
.hypothesis/
62+
.pytest_cache/
63+
64+
# Translations
65+
*.mo
66+
*.pot
67+
68+
# Django stuff:
69+
*.log
70+
local_settings.py
71+
db.sqlite3
72+
db.sqlite3-journal
73+
74+
# Flask stuff:
75+
instance/
76+
.webassets-cache
77+
78+
# Scrapy stuff:
79+
.scrapy
80+
81+
# Sphinx documentation
82+
docs/_build/
83+
84+
# PyBuilder
85+
target/
86+
87+
# Jupyter Notebook
88+
.ipynb_checkpoints
89+
90+
# IPython
91+
profile_default/
92+
ipython_config.py
93+
94+
# pyenv
95+
.python-version
96+
97+
# pipenv
98+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
99+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
100+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
101+
# install all needed dependencies.
102+
#Pipfile.lock
103+
104+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
105+
__pypackages__/
106+
107+
# Celery stuff
108+
celerybeat-schedule
109+
celerybeat.pid
110+
111+
# SageMath parsed files
112+
*.sage.py
113+
114+
# Environments
115+
.env
116+
.venv
117+
env/
118+
venv/
119+
ENV/
120+
env.bak/
121+
venv.bak/
122+
123+
# Spyder project settings
124+
.spyderproject
125+
.spyproject
126+
127+
# Rope project settings
128+
.ropeproject
129+
130+
# mkdocs documentation
131+
/site
132+
133+
# mypy
134+
.mypy_cache/
135+
.dmypy.json
136+
dmypy.json
137+
138+
# Pyre type checker
139+
.pyre/
140+
141+
# pycharm
142+
.idea
143+
# Local vscode editor config
144+
.vscode

0 commit comments

Comments
 (0)