Skip to content
This repository was archived by the owner on Feb 13, 2025. It is now read-only.

Commit daf634e

Browse files
author
Joseph Burling
committed
build(retrocookie): reflect updates to source template from generated project 'element-data-model'
1 parent e8eb5af commit daf634e

File tree

9 files changed

+20
-23
lines changed

9 files changed

+20
-23
lines changed

datajoint-workflow/cookiecutter.json

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
"author_email": "{{cookiecutter.author_name|words(1)|lower}}@datajoint.com",
44
"organization": "Science Institute",
55
"workflow": "Brain Lab",
6-
"__org": "{{cookiecutter.organization|slugify}}",
7-
"__wf": "{{cookiecutter.workflow|slugify}}",
6+
"pkg_type": "SciOps",
87
"github_user": [
98
"dj-sciops",
109
"datajoint",
@@ -14,7 +13,7 @@
1413
"yambottle",
1514
"other-gh-username"
1615
],
17-
"github_repo": "{{cookiecutter.__org}}_{{cookiecutter.__wf}}",
16+
"github_repo": "{{cookiecutter.organization|slugify}}_{{cookiecutter.workflow|slugify}}",
1817
"python_version": [
1918
"3.9",
2019
"3.10",
@@ -23,9 +22,8 @@
2322
"_pkg_version": "0.0.1",
2423
"homepage_url": "https://github.com/{{cookiecutter.github_user}}",
2524
"docs_url": "https://{{cookiecutter.github_user}}.github.io/{{cookiecutter.github_repo}}",
26-
"__project_name": "sciops-{{cookiecutter.__wf}}",
27-
"__pkg_import_name": "sciops{{cookiecutter.__wf|slugify(separator='')}}",
28-
"__pkg_import_sc_name": "sciops_{{cookiecutter.__wf|slugify(separator='_')}}",
25+
"__project_name": "{{cookiecutter.pkg_type|lower}}-{{cookiecutter.workflow|slugify}}",
26+
"__pkg_import_name": "{{cookiecutter.pkg_type|lower}}_{{cookiecutter.workflow|slugify(separator='_')}}",
2927
"_djconfig": "dj_local_conf.json",
3028
"_copy_without_render": [
3129
"docs/assets/*.svg",

datajoint-workflow/{{cookiecutter.github_repo}}/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ _View the latest documentation site here:_ [{{cookiecutter.docs_url}}]({{cookiec
44

55
# `{{cookiecutter.__project_name}}`
66

7-
_A DataJoint SciOps Workflow for {{cookiecutter.organization}}, {{cookiecutter.workflow}}_
7+
_A {{cookiecutter.workflow}} {{cookiecutter.pkg_type}} for {{cookiecutter.organization}}_
88

99
## Description
1010

1111
TODO: finish description.
1212

13-
Welcome to the DataJoint SciOps service!
13+
Welcome to the {{cookiecutter.organization}} {{cookiecutter.pkg_type}} service!
1414

1515
This service is designed for a user to upload their raw [_modality type_] data acquired with [_description_], which will then be automatically processed with [_..._]. The service also provides online Jupyter notebooks to visualize the results.
1616

@@ -21,7 +21,7 @@ This [workflow](https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.g
2121

2222
Please follow the steps listed below to begin working with the platform.
2323

24-
## Using the SciOps Services
24+
## Using the {{cookiecutter.pkg_type}} Services
2525

2626
### Account Setup
2727

@@ -95,12 +95,12 @@ DataJoint LabBook displays data from your database.
9595
<!--intro-end-->
9696
<!--install-start-->
9797

98-
Thank you for using the DataJoint SciOps cloud-based platform.
98+
Thank you for using the {{cookiecutter.organization}} {{cookiecutter.pkg_type}} cloud-based platform.
9999

100100
## Installation
101101

102102
!!! note
103-
The following is intended for developers and is not required for users of the SciOps services.
103+
The following is intended for developers and is not required for users of the {{cookiecutter.pkg_type}} services.
104104

105105
### 1. Clone the repository
106106

datajoint-workflow/{{cookiecutter.github_repo}}/docker/.devcontainer/devcontainer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
"docker"
3737
],
3838
"djcookiecutter.condaExec": "mamba",
39-
"djcookiecutter.localPath": "${env:HOME}/Documents/{{cookiecutter.__org}}/dj-cookiecutter",
39+
"djcookiecutter.localPath": "${env:HOME}/Documents/datajoint/dj-cookiecutter",
4040
"files.exclude": {
4141
"**/.DS_Store": true,
4242
"**/.git": true,
@@ -85,5 +85,5 @@
8585
"python.testing.pytestEnabled": true
8686
},
8787
"shutdownAction": "none",
88-
"workspaceFolder": "/home/{{cookiecutter.github_user}}/{{cookiecutter.__org}}_{{cookiecutter.__wf}}"
88+
"workspaceFolder": "/home/{{cookiecutter.github_user}}/{{cookiecutter.github_repo}}"
8989
}

datajoint-workflow/{{cookiecutter.github_repo}}/docker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ cd docker
5656
docker-compose -f docker-compose-codebook_env.yaml up --detach --force-recreate --remove-orphans --build
5757
```
5858

59-
## Standard Workflow Environment
59+
## Standard {{cookiecutter.pkg_type}} Environment
6060

6161
...
6262

datajoint-workflow/{{cookiecutter.github_repo}}/docker/devcontainer.Dockerfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
ARG PROJECT_NAME={{cookiecutter.__project_name}}
44
ARG IMPORT_NAME={{cookiecutter.__pkg_import_name}}
55
ARG REPO_OWNER={{cookiecutter.github_user}}
6-
ARG REPO_NAME={{cookiecutter.__org}}_{{cookiecutter.__wf}}
6+
ARG REPO_NAME={{cookiecutter.github_repo}}
77
ARG HOST_UID=1000
88
ARG HOST_GID=1000
99
ARG USER_SUDO=true
@@ -92,7 +92,7 @@ USER ${NEW_USER_NAME}:${NEW_USER_GROUP}
9292
RUN <<-EOF
9393
rm -rf .nox .git .mypy_cache .pytest_cache site build
9494
cp -f /usr/local/src/.datajoint_config.json ../.datajoint_config.json
95-
mkdir -p .nox src/{{cookiecutter.__pkg_import_sc_name}}.egg-info \
95+
mkdir -p .nox src/{{cookiecutter.__pkg_import_name}}.egg-info \
9696
../.vscode-server/extensions ../.vscode-server-insiders/extensions
9797
chmod -R 2775 ../.vscode-server*
9898
source activate
@@ -117,7 +117,7 @@ ENV TZ=${TIMEZONE}
117117
ENV LANG=en_US.UTF-8
118118
ENV LC_ALL=en_US.UTF-8
119119
LABEL org.opencontainers.image.authors "Joseph M. Burling"
120-
LABEL org.opencontainers.image.title "{{cookiecutter.__org}}_{{cookiecutter.__wf}}"
120+
LABEL org.opencontainers.image.title "{{cookiecutter.github_repo}}"
121121
LABEL org.opencontainers.image.description "A development container with a debian-based python environment"
122122
LABEL org.opencontainers.image.version "$WORKFLOW_VERSION"
123123
LABEL org.opencontainers.image.created "$IMAGE_DATE"

datajoint-workflow/{{cookiecutter.github_repo}}/docker/docker-compose-devcontainer_env.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ services:
4242
- vscode:/home/${REPO_OWNER}/.vscode-server/extensions
4343
- vscode-insiders:/home/${REPO_OWNER}/.vscode-server-insiders/extensions
4444
- /home/${REPO_OWNER}/${REPO_NAME}/.nox
45-
- /home/${REPO_OWNER}/${REPO_NAME}/src/{{cookiecutter.__pkg_import_sc_name}}.egg-info
45+
- /home/${REPO_OWNER}/${REPO_NAME}/src/{{cookiecutter.__pkg_import_name}}.egg-info
4646

4747
# MySQL GUI --------------
4848
# http://localhost:8087/

datajoint-workflow/{{cookiecutter.github_repo}}/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
site_name: "Datajoint Workflow {{cookiecutter.workflow}}"
2-
site_description: "A DataJoint SciOps Workflow for {{cookiecutter.organization}}, {{cookiecutter.workflow}}"
1+
site_name: "{{cookiecutter.organization}} {{cookiecutter.pkg_type}} - {{cookiecutter.workflow}}"
2+
site_description: "A {{cookiecutter.workflow}} {{cookiecutter.pkg_type}} for {{cookiecutter.organization}}"
33
site_author: "{{cookiecutter.author_name}}"
44
repo_url: "https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.github_repo}}"
55
edit_uri: ""

datajoint-workflow/{{cookiecutter.github_repo}}/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "{{cookiecutter.__project_name}}"
7-
description = "A DataJoint SciOps Workflow for {{cookiecutter.organization}}, {{cookiecutter.workflow}}"
7+
description = "A {{cookiecutter.workflow}} {{cookiecutter.pkg_type}} for {{cookiecutter.organization}}"
88
readme = "README.md"
99
requires-python = ">={{cookiecutter.python_version}}"
1010
license = { file = "LICENSE" }

datajoint-workflow/{{cookiecutter.github_repo}}/src/{{cookiecutter.__pkg_import_name}}/__init__.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
"""`{{cookiecutter.__project_name}}`:
2-
_A DataJoint SciOps Workflow for
3-
{{cookiecutter.organization}}, {{cookiecutter.workflow}}_
2+
_A {{cookiecutter.workflow}} {{cookiecutter.pkg_type}} for {{cookiecutter.organization}}_
43
"""
54

65
import logging

0 commit comments

Comments
 (0)