feat(.copier-hyfi-config.yaml): add new configuration file for the pr…

…oject cobots2024
halla-ai · Mar 3, 2024 · 41842dd · 41842dd
1 parent 0542d90
commit 41842dd
Show file tree

Hide file tree

Showing 23 changed files with 2,057 additions and 144 deletions.
diff --git a/.copier-config.yaml b/.copier-config.yaml
@@ -1,34 +1,36 @@
 # Changes here will be overwritten by Copier; do NOT edit manually
-_commit: v0.12.1-1-ged875bd
+_commit: v0.12.1
 _src_path: gh:entelecheia/hyperfast-python-template
 author: Young Joon Lee
-build_and_release: false
+build_and_release: true
 code_template_answers_file: .copier-hyfi-config.yaml
-code_template_source: ''
+code_template_source: gh:entelecheia/hyfi-template
 codecov_graph_token: '[REPLACE_ME]'
 copyright_year: 2024
 documentaion_tool: jupyter-book
-documentation_url: https://entelecheia.github.io/course-template
-email: entelecheia@hotmail.com
+documentation_url: https://cobots2024.halla.ai
+email: yj.lee@chu.ac.kr
 favicon_path: https://assets.entelecheia.ai/favicon.png
-friendly_name: Course Template
-github_repo_name: course-template
-github_username: entelecheia
-google_analytics_id: ''
+friendly_name: 협동로봇활용 2024
+github_repo_name: cobots-2024
+github_username: chu-aie
+google_analytics_id: G-BQJE5V9RK2
 logo_path: ''
 main_branch: main
-package_name: coursetemp
+package_name: cobots2024
 package_scripts:
-- coursetemp = 'coursetemp.__cli__:main'
+- cobots2024 = 'cobots2024.__cli__:main'
 poe_task_files:
 - .tasks.toml
 - .tasks-extra.toml
-project_description: A template for a course
+project_description: 이 과정은 협동로봇의 기본적인 이해부터 고급 프로그래밍 기술까지 다루며, 학생들이 협동로봇을 활용한 다양한 작업
+    공정을 설계하고 구현할 수 있는 능력을 배양하는 것을 목표로 합니다. 로봇 시스템 설치, 조작, 프로그래밍, 그리고 실제 작업 공정 구현까지의
+    전 과정을 학습합니다.
 project_license: CC-BY-4.0
-project_name: course-template
-project_short_description: A template for a course
-upload_to_release: false
-upload_to_repository: false
+project_name: cobots2024
+project_short_description: Collaborative Robot Applications
+upload_to_release: true
+upload_to_repository: true
 use_launch_buttons: true
-use_source_code_skeleton: false
+use_source_code_skeleton: true
 
diff --git a/.copier-hyfi-config.yaml b/.copier-hyfi-config.yaml
@@ -0,0 +1,6 @@
+# Changes here will be overwritten by Copier; do NOT edit manually
+_commit: v0.6.10
+_src_path: gh:entelecheia/hyfi-template
+package_name: cobots2024
+project_name: cobots2024
+
diff --git a/.copierignore b/.copierignore
@@ -1,11 +1,8 @@
 .copierignore
 .tasks-extra.toml
 CHANGELOG.md
-pyproject.toml
 Makefile
 .gitignore
 deploy-app-image.yaml
 deploy-base-image.yaml
 lint_and_test.yaml
-release.yaml
-_toc.yml
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -20,6 +20,14 @@ updates:
       interval: "daily"
       time: "03:00"
       timezone: "Asia/Seoul"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "03:00"
+      timezone: "Asia/Seoul"
+    allow:
+      - dependency-type: "production"
     labels:
       - ":game_die: dependencies"
       - ":robot: bot"
diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml
@@ -40,4 +40,4 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: book/_build/html
-          cname: 
+          cname: cobots2024.halla.ai
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -8,7 +8,8 @@ on:
     branches:
       - release*
     paths:
-      - ".docker/**"
+      - 'src/**'
+      - 'pyproject.toml'
 
 permissions:
   contents: write
@@ -53,3 +54,5 @@ jobs:
           poetry run semantic-release publish --verbosity=DEBUG --define=branch=${{ env.BRANCH }}
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPOSITORY_USERNAME: __token__
+          REPOSITORY_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/.tasks-extra.toml b/.tasks-extra.toml
@@ -1,6 +1,23 @@
-[tool.poe.tasks.hello]
-cmd = "echo 'Hello World'"
-help = "Put your extra tasks here"
+[tool.poe.tasks.add-editable-hyfi]
+shell = """
+  poetry remove hyfi
+  poetry add --group dev --editable ../hyfi
+"""
+help = "Add hyfi as an editable dependency"
+
+[tool.poe.tasks.apply-hyfi-template]
+cmd = """
+  copier --answers-file .copier-hyfi-config.yaml gh:entelecheia/hyfi-template .
+"""
+use_exec = true
+help = "Apply hyfi template"
+
+[tool.poe.tasks.copy-hyfi-config]
+shell = """
+  poetry add hyfi@latest
+  poetry run hyfi cmd=copy_conf copier.dst_path=src/cobots2024/conf copier.exclude='**/*/about/__init__.yaml' copier.overwrite=True
+"""
+help = "Copy hyfi conf to src/cobots2024/conf"
 
 [tool.poe.tasks.generate_toc]
 cmd = "python3 .github/scripts/autotoc.py"

diff --git a/.tasks.toml b/.tasks.toml
@@ -66,6 +66,14 @@ help = "remove documentation artifacts"
 sequence = ["clean-cov", "clean-pycache", "clean-build", "clean-docs"]
 help = "remove build artifacts and coverage reports"
 
+[tool.poe.tasks.run]
+cmd = "cobots2024"
+help = "run the main program"
+
+[tool.poe.tasks.build]
+cmd = "poetry build"
+help = "build the package"
+
 [tool.poe.tasks.install-ghp-import]
 cmd = "pipx install ghp-import"
 help = "install ghp-import"

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[entelecheia@hotmail.com](mailto:entelecheia@hotmail.com).
+[yj.lee@chu.ac.kr](mailto:yj.lee@chu.ac.kr).
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -25,8 +25,8 @@ and "help wanted" is open to whoever wants to implement it.
 
 ## Write Documentation
 
-Course Template could always use more documentation, whether as part of the
-official Course Template docs, in docstrings, or even on the web in blog posts,
+협동로봇활용 2024 could always use more documentation, whether as part of the
+official 협동로봇활용 2024 docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 ## Submit Feedback
@@ -42,7 +42,7 @@ If you are proposing a feature:
 
 ## Get Started
 
-Ready to contribute? Here's how to set up `Course Template` for local development.
+Ready to contribute? Here's how to set up `협동로봇활용 2024` for local development.
 
 1. Fork the repo on GitHub.
 2. Clone your fork locally.
@@ -52,4 +52,4 @@ Ready to contribute? Here's how to set up `Course Template` for local developmen
 
 ## Code of Conduct
 
-Please note that the Course Template project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms.
+Please note that the 협동로봇활용 2024 project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms.
diff --git a/README.md b/README.md
@@ -1,12 +1,13 @@
-# Course Template
-
+# 협동로봇활용 2024
 
 [![halla-img]][halla-url]
 [![course-img]][course-url]
 [![lecture-img]][lecture-url]
+[![pypi-image]][pypi-url]
 [![version-image]][release-url]
 [![release-date-image]][release-url]
 [![license-image]][license-url]
+[![codecov][codecov-image]][codecov-url]
 [![jupyter-book-image]][docs-url]
 
 <!-- Links: -->
@@ -17,30 +18,30 @@
 [lecture-img]: https://img.shields.io/badge/lecture-entelecheia.ai-blue
 [lecture-url]: https://lecture.entelecheia.ai
 
-[codecov-image]: https://codecov.io/gh/entelecheia/course-template/branch/main/graph/badge.svg?token=[REPLACE_ME]
-[codecov-url]: https://codecov.io/gh/entelecheia/course-template
-[pypi-image]: https://img.shields.io/pypi/v/course-template
-[license-image]: https://img.shields.io/github/license/entelecheia/course-template
-[license-url]: https://github.com/entelecheia/course-template/blob/main/LICENSE
-[version-image]: https://img.shields.io/github/v/release/entelecheia/course-template?sort=semver
-[release-date-image]: https://img.shields.io/github/release-date/entelecheia/course-template
-[release-url]: https://github.com/entelecheia/course-template/releases
+[codecov-image]: https://codecov.io/gh/chu-aie/cobots-2024/branch/main/graph/badge.svg?token=[REPLACE_ME]
+[codecov-url]: https://codecov.io/gh/chu-aie/cobots-2024
+[pypi-image]: https://img.shields.io/pypi/v/cobots2024
+[license-image]: https://img.shields.io/github/license/chu-aie/cobots-2024
+[license-url]: https://github.com/chu-aie/cobots-2024/blob/main/LICENSE
+[version-image]: https://img.shields.io/github/v/release/chu-aie/cobots-2024?sort=semver
+[release-date-image]: https://img.shields.io/github/release-date/chu-aie/cobots-2024
+[release-url]: https://github.com/chu-aie/cobots-2024/releases
 [jupyter-book-image]: https://jupyterbook.org/en/stable/_images/badge.svg
 
-[repo-url]: https://github.com/entelecheia/course-template
-[pypi-url]: https://pypi.org/project/course-template
-[docs-url]: https://entelecheia.github.io/course-template
-[changelog]: https://github.com/entelecheia/course-template/blob/main/CHANGELOG.md
-[contributing guidelines]: https://github.com/entelecheia/course-template/blob/main/CONTRIBUTING.md
+[repo-url]: https://github.com/chu-aie/cobots-2024
+[pypi-url]: https://pypi.org/project/cobots2024
+[docs-url]: https://cobots2024.halla.ai
+[changelog]: https://github.com/chu-aie/cobots-2024/blob/main/CHANGELOG.md
+[contributing guidelines]: https://github.com/chu-aie/cobots-2024/blob/main/CONTRIBUTING.md
 <!-- Links: -->
 
-A template for a course
-
-- Documentation: [https://entelecheia.github.io/course-template][docs-url]
-- GitHub: [https://github.com/entelecheia/course-template][repo-url]
+Collaborative Robot Applications
 
+- Documentation: [https://cobots2024.halla.ai][docs-url]
+- GitHub: [https://github.com/chu-aie/cobots-2024][repo-url]
+- PyPI: [https://pypi.org/project/cobots2024][pypi-url]
 
-A template for a course
+이 과정은 협동로봇의 기본적인 이해부터 고급 프로그래밍 기술까지 다루며, 학생들이 협동로봇을 활용한 다양한 작업 공정을 설계하고 구현할 수 있는 능력을 배양하는 것을 목표로 합니다. 로봇 시스템 설치, 조작, 프로그래밍, 그리고 실제 작업 공정 구현까지의 전 과정을 학습합니다.
 
 ## Changelog
 

diff --git a/book/_config.yml b/book/_config.yml
@@ -5,7 +5,7 @@
 
 #######################################################################################
 # Book settings
-title: "Course Template" # The title of the book. Will be placed in the left navbar.
+title: "협동로봇활용 2024" # The title of the book. Will be placed in the left navbar.
 author: "Young Joon Lee" # The author of the book
 copyright: "2024" # Copyright year to be placed in the footer
 # logo: Path to the book logo
@@ -29,7 +29,7 @@ bibtex_bibfiles:
 
 # Information about where the book exists on the web
 repository:
-  url: https://github.com/entelecheia/course-template # Online location of your book
+  url: https://github.com/chu-aie/cobots-2024 # Online location of your book
   path_to_book: book # Optional path to your book, relative to the repository root
   branch: main # Which branch of the repository should be used when creating links (optional)
 
@@ -40,7 +40,7 @@ html:
   use_repository_button: true
   use_edit_page_button: true
   favicon: https://assets.entelecheia.ai/favicon.png # favicon: Path to the favicon image
-  # google_analytics_id: Google Analytics ID
+  google_analytics_id: G-BQJE5V9RK2 # google_analytics_id: Google Analytics ID
 
 sphinx:
   config:

diff --git a/book/index.md b/book/index.md
@@ -1,37 +1,39 @@
-# Course Template
+# 협동로봇활용 2024
 
+[![pypi-image]][pypi-url]
 [![version-image]][release-url]
 [![release-date-image]][release-url]
 [![license-image]][license-url]
 [![jupyter-book-image]][docs-url]
+[![codecov][codecov-image]][codecov-url]
 
 <!-- Links: -->
 [hyperfast python template]: https://github.com/entelecheia/hyperfast-python-template
 
-[codecov-image]: https://codecov.io/gh/entelecheia/course-template/branch/main/graph/badge.svg?token=[REPLACE_ME]
-[codecov-url]: https://codecov.io/gh/entelecheia/course-template
-[pypi-image]: https://img.shields.io/pypi/v/course-template
-[license-image]: https://img.shields.io/github/license/entelecheia/course-template
-[license-url]: https://github.com/entelecheia/course-template/blob/main/LICENSE
-[version-image]: https://img.shields.io/github/v/release/entelecheia/course-template?sort=semver
-[release-date-image]: https://img.shields.io/github/release-date/entelecheia/course-template
-[release-url]: https://github.com/entelecheia/course-template/releases
+[codecov-image]: https://codecov.io/gh/chu-aie/cobots-2024/branch/main/graph/badge.svg?token=[REPLACE_ME]
+[codecov-url]: https://codecov.io/gh/chu-aie/cobots-2024
+[pypi-image]: https://img.shields.io/pypi/v/cobots2024
+[license-image]: https://img.shields.io/github/license/chu-aie/cobots-2024
+[license-url]: https://github.com/chu-aie/cobots-2024/blob/main/LICENSE
+[version-image]: https://img.shields.io/github/v/release/chu-aie/cobots-2024?sort=semver
+[release-date-image]: https://img.shields.io/github/release-date/chu-aie/cobots-2024
+[release-url]: https://github.com/chu-aie/cobots-2024/releases
 [jupyter-book-image]: https://jupyterbook.org/en/stable/_images/badge.svg
 
-[repo-url]: https://github.com/entelecheia/course-template
-[pypi-url]: https://pypi.org/project/course-template
-[docs-url]: https://entelecheia.github.io/course-template
-[changelog]: https://github.com/entelecheia/course-template/blob/main/CHANGELOG.md
-[contributing guidelines]: https://github.com/entelecheia/course-template/blob/main/CONTRIBUTING.md
+[repo-url]: https://github.com/chu-aie/cobots-2024
+[pypi-url]: https://pypi.org/project/cobots2024
+[docs-url]: https://cobots2024.halla.ai
+[changelog]: https://github.com/chu-aie/cobots-2024/blob/main/CHANGELOG.md
+[contributing guidelines]: https://github.com/chu-aie/cobots-2024/blob/main/CONTRIBUTING.md
 <!-- Links: -->
 
-A template for a course
+Collaborative Robot Applications
 
-- Documentation: [https://entelecheia.github.io/course-template][docs-url]
-- GitHub: [https://github.com/entelecheia/course-template][repo-url]
-- PyPI: [https://pypi.org/project/course-template][pypi-url]
+- Documentation: [https://cobots2024.halla.ai][docs-url]
+- GitHub: [https://github.com/chu-aie/cobots-2024][repo-url]
+- PyPI: [https://pypi.org/project/cobots2024][pypi-url]
 
-A template for a course
+이 과정은 협동로봇의 기본적인 이해부터 고급 프로그래밍 기술까지 다루며, 학생들이 협동로봇을 활용한 다양한 작업 공정을 설계하고 구현할 수 있는 능력을 배양하는 것을 목표로 합니다. 로봇 시스템 설치, 조작, 프로그래밍, 그리고 실제 작업 공정 구현까지의 전 과정을 학습합니다.
 
 ## Changelog