feat: initial version

entelecheia · Mar 1, 2023 · 0c4cf1e · 0c4cf1e
1 parent 03702c6
commit 0c4cf1e
Show file tree

Hide file tree

Showing 36 changed files with 339 additions and 324 deletions.
diff --git a/.copier-config.yaml b/.copier-config.yaml
@@ -1,21 +1,20 @@
 # Changes here will be overwritten by Copier; do NOT edit manually
-_commit: v0.1.3
-_src_path: .
+_commit: v0.1.9
+_src_path: gh:entelecheia/hyperfast-python-template
 author: Young Joon Lee
 copyright_year: 2023
 documentaion_tool: jupyter-book
-documentation_url: https://hyperfast-python.entelecheia.cc
+documentation_url: https://hyfi.entelecheia.cc
 email: entelecheia@hotmail.com
-friendly_name: Hyperfast Python Template
-github_repo_name: hyperfast-python-template
+friendly_name: 'HyFI: Hydra Fast Interface'
+github_repo_name: hyfi
 github_username: entelecheia
-package_name: hyperfastpy
-project_description: Hyperfast Python Template is a self-contained template that helps
-    you initialize your Python project inside the template. It is hyperfast in the
-    sense that the template itself is converted into a Python project in the blink
-    of an eye. It is also hyperfast in the sense that it helps you jump start your
-    project with the best practices in the Python community.
+package_name: hyfi
+project_description: HyFI is a framework for building interfaces for Python applications.
+    It is based on [Hydra] and [Pydantic] and provides a set of tools to build interfaces
+    for Python applications.
 project_license: MIT
-project_name: hyperfast-python-template
-project_short_description: A python template that helps you jump start your project
+project_name: hyfi
+project_short_description: Hydra Fast Interface (Hydra and Pydantic based interface
+    framework)
 
diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml
@@ -20,13 +20,6 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      # init project
-      - name: Init project
-        if: github.repository == 'entelecheia/hyperfast-python-template'
-        run: |
-          pipx install copier>=7.0.0
-          make reinit-project-force
-
       - uses: actions/setup-python@v4
         with:
           python-version: 3.x

diff --git a/.github/workflows/lint_and_test.yaml b/.github/workflows/lint_and_test.yaml
@@ -29,13 +29,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      # init project
-      - name: Init project
-        if: github.repository == 'entelecheia/hyperfast-python-template'
-        run: |
-          pipx install copier>=7.0.0
-          make reinit-project-force
-
       # install poetry
       - name: Install poetry
         run: pipx install poetry>=1.3.2

diff --git a/.github/workflows/prerelease-to-test-pypi.yaml b/.github/workflows/prerelease-to-test-pypi.yaml
@@ -29,13 +29,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      # install copier and init project
-      - name: Install copier and init project
-        if: github.repository == 'entelecheia/hyperfast-python-template'
-        run: |
-          pipx install copier>=7.0.0
-          make reinit-project-force
-
       # set env variable
       - name: Set env variable
         run: echo "BRANCH=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV

diff --git a/.github/workflows/prerelease.yaml b/.github/workflows/prerelease.yaml
@@ -36,13 +36,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      # install copier and init project
-      - name: Install copier and init project
-        if: github.repository == 'entelecheia/hyperfast-python-template'
-        run: |
-          pipx install copier>=7.0.0
-          make reinit-project-force
-
       # set env variable
       - name: Set env variable
         run: echo "BRANCH=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV

diff --git a/.github/workflows/release-patch.yaml b/.github/workflows/release-patch.yaml
@@ -32,13 +32,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      # install copier and init project
-      - name: Install copier and init project
-        if: github.repository == 'entelecheia/hyperfast-python-template'
-        run: |
-          pipx install copier>=7.0.0
-          make reinit-project-force
-
       # set env variable
       - name: Set env variable
         run: echo "BRANCH=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV

diff --git a/.github/workflows/release-test.yaml b/.github/workflows/release-test.yaml
@@ -31,13 +31,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      # install copier and init project
-      - name: Install copier and init project
-        if: github.repository == 'entelecheia/hyperfast-python-template'
-        run: |
-          pipx install copier>=7.0.0
-          make reinit-project-force
-
       # set env variable
       - name: Set env variable
         run: echo "BRANCH=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -32,13 +32,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      # install copier and init project
-      - name: Install copier and init project
-        if: github.repository == 'entelecheia/hyperfast-python-template'
-        run: |
-          pipx install copier>=7.0.0
-          make reinit-project-force
-
       # set env variable
       - name: Set env variable
         run: echo "BRANCH=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV

diff --git a/.gitignore b/.gitignore
@@ -25,10 +25,3 @@ coverage.xml
 htmlcov/
 pytest-coverage.*
 
-# for template test
-src/hyperfastpy/
-tests/hyperfastpy/
-/book/
-/docs/
-/mkdocs.yaml
-/.readthedocs.yaml
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,24 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+  jobs:
+    pre_build:
+      # Generate on-the-fly Sphinx configuration from Jupyter Book's _config.yml
+      - "jupyter-book config sphinx docs/"
+
+formats:
+  - pdf
+  - epub
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt
diff --git a/.version b/.version
@@ -0,0 +1 @@
+VERSION=0.0.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,112 +1 @@
 <!--next-version-placeholder-->
-
-## v0.1.8 (2023-02-27)
-### Fix
-* Docs requirements.txt ([`7404bb4`](https://github.com/entelecheia/hyperfast-python-template/commit/7404bb46d5205957a02c7497dcd3e93df29b2f66))
-
-## v0.1.7 (2023-02-27)
-### Fix
-* README template ext ([`c3a26ce`](https://github.com/entelecheia/hyperfast-python-template/commit/c3a26ceadae4fd4936e20d376d1b7530ff1f8f80))
-
-### Documentation
-* Update README ([`6233d2d`](https://github.com/entelecheia/hyperfast-python-template/commit/6233d2d3b1206cae51b2942c31e7acebabb45e9c))
-* Add google analytics ([`0d72551`](https://github.com/entelecheia/hyperfast-python-template/commit/0d7255182e4fe341db9f91693afaf93c48feebad))
-
-## v0.1.6 (2023-02-24)
-### Fix
-* Github action templates ([`d3eadb0`](https://github.com/entelecheia/hyperfast-python-template/commit/d3eadb04c3514c55668f9d46934fab2ae97e2ae0))
-
-## v0.1.5 (2023-02-24)
-### Fix
-* Index of mkdocs template ([`40a1d0e`](https://github.com/entelecheia/hyperfast-python-template/commit/40a1d0e0cefde85843fca78860b738288cd636ae))
-
-## v0.1.4 (2023-02-24)
-### Fix
-* Makefile ([`56c76a4`](https://github.com/entelecheia/hyperfast-python-template/commit/56c76a42de67a646efc77e0de4cb096a22ec7ffb))
-
-## v0.1.3 (2023-02-24)
-### Fix
-* Release actions ([`4412d46`](https://github.com/entelecheia/hyperfast-python-template/commit/4412d46a93cbdec94215a84a4313fa4fb0ac2fdb))
-
-## v0.1.2 (2023-02-24)
-### Fix
-* Release actions ([`cbb191d`](https://github.com/entelecheia/hyperfast-python-template/commit/cbb191df537ae6ca40524f443ad3d77d31dcefa5))
-
-## v0.1.2-rc.2 (2023-02-24)
-
-
-## v0.1.2-rc.1 (2023-02-24)
-
-
-## v0.1.1 (2023-02-24)
-### Fix
-* Add CNAME github variable for gh-pages action ([`535401d`](https://github.com/entelecheia/hyperfast-python-template/commit/535401de5aa5c0e956790addcdf2ee63c0464370))
-
-## v0.1.0 (2023-02-24)
-### Feature
-* Initial version ([`323d59b`](https://github.com/entelecheia/hyperfast-python-template/commit/323d59bfc75e7527653f22338ee7f16c268478ed))
-
-### Documentation
-* Update README ([`0dbeddf`](https://github.com/entelecheia/hyperfast-python-template/commit/0dbeddf1c8e07371a48d34bdc466ba3ad09c262f))
-* Update README ([`6f21e8b`](https://github.com/entelecheia/hyperfast-python-template/commit/6f21e8b7bfdd512ead7e9b709dcd35d54e50f4e4))
-
-## v0.0.1-rc.18 (2023-02-24)
-
-
-## v0.0.1-rc.17 (2023-02-24)
-
-
-## v0.0.1-rc.16 (2023-02-24)
-
-
-## v0.0.1-rc.15 (2023-02-24)
-
-
-## v0.0.1-rc.14 (2023-02-20)
-
-
-## v0.0.1-rc.13 (2023-02-20)
-### Documentation
-* **jupyter-book:** Add templates for jupyter-book ([`eb10902`](https://github.com/entelecheia/hyperfast-python-template/commit/eb10902285cecf903add44efdeb4548d5eef5556))
-
-## v0.0.1-rc.12 (2023-02-20)
-### Documentation
-* **mkdocs:** Add mkdocs template ([`2016814`](https://github.com/entelecheia/hyperfast-python-template/commit/201681498c2242518c77eaf089b06e49ad1ecfd0))
-* **readme:** Add explanation ([`61e072e`](https://github.com/entelecheia/hyperfast-python-template/commit/61e072e929a289f59def43130ba03c77ba247406))
-
-## v0.0.1-rc.11 (2023-02-20)
-
-
-## v0.0.1-rc.10 (2023-02-20)
-### Documentation
-* **readme:** Update README ([`72b3b4b`](https://github.com/entelecheia/hyperfast-python-template/commit/72b3b4b5e00392bc1ffcc8519a6ee72e8696c9ea))
-* **conduct:** Add code of conduct ([`b82c6c9`](https://github.com/entelecheia/hyperfast-python-template/commit/b82c6c9bcf6c0348eaba5065b973553b92b3d94e))
-
-## v0.0.1-rc.9 (2023-02-19)
-
-
-## v0.0.1-rc.8 (2023-02-19)
-### Fix
-* **test:** Add github step summary ([`0134591`](https://github.com/entelecheia/pypi-template/commit/0134591c4d6b815843110ad8cbe2f4974c893ff8))
-
-## v0.0.1-rc.7 (2023-02-17)
-### Fix
-* **tests:** Add test codes and related configs ([`9125ccd`](https://github.com/entelecheia/pypi-template/commit/9125ccd2c41af688283b3d5bc53669e2dfda0a9c))
-
-## v0.0.1-rc.6 (2023-02-17)
-
-
-## v0.0.1-rc.5 (2023-02-17)
-
-
-## v0.0.1-rc.4 (2023-02-17)
-
-
-## v0.0.1-rc.3 (2023-02-17)
-
-
-## v0.0.1-rc.2 (2023-02-17)
-
-
-## v0.0.1-rc.1 (2023-02-17)
-
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
 
-Hyperfast Python Template could always use more documentation, whether as part of the
-official Hyperfast Python Template docs, in docstrings, or even on the web in blog posts,
+HyFI: Hydra Fast Interface could always use more documentation, whether as part of the
+official HyFI: Hydra Fast Interface 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 `Hyperfast Python Template` for local development.
+Ready to contribute? Here's how to set up `HyFI: Hydra Fast Interface` 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 `Hyperfast Python Template` for local
 
 ## Code of Conduct
 
-Please note that the Hyperfast Python 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 HyFI: Hydra Fast Interface 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/Makefile b/Makefile
@@ -60,7 +60,7 @@ lint: lint-black lint-isort lint-flake8 lint-mypy ## run all linters
 
 .PHONY: run
 run: ## run the main script
-	@poetry run hyperfastpy
+	@poetry run hyfi
 
 ##@ Testing
 
@@ -191,10 +191,11 @@ remove-template: ## remove the template files (Warning: if you do this, you can'
 	@rm -rf .copier-template
 
 init-project: install-copier install-precommit-hooks ## initialize the project (Warning: do this only once!)
-	@copier gh:entelecheia/hyperfast-template .
+	@copier gh:entelecheia/hyperfast-python-template .
 
 init-git: ## initialize git
 	@git init
 
-reinit-project-force: install-copier ## initialize the project ignoring existing files (*Warning* this will overwrite existing files!)
-	@copier --answers-file .copier-config.yaml --force --vcs-ref=HEAD . .
+
+reinit-project: install-copier ## reinitialize the project
+	@copier --answers-file .copier-config.yaml gh:entelecheia/hyperfast-python-template .