Initial Commit

.devcontainer/devcontainer.json

@@ -1,5 +1,5 @@
 {
-  "name": "python_template",
+  "name": "bert_score_api",
   "dockerComposeFile": [
     "../docker-compose.yml",
     "docker-compose.yml"

.pre-commit-config.yaml

@@ -48,7 +48,7 @@ repos:
   #   rev: v0.991
   #   hooks:
   #     - id: mypy
-  #       files: python_template
+  #       files: bert_score_api
   #       additional_dependencies: [types-PyYAML, rich]
   #       args: [
   #           "--strict",

Makefile

@@ -2,17 +2,17 @@
 # chain commands together with semicolon
 .ONESHELL:
 SHELL=/bin/bash
-ROOT_DIR=python-template
-PACKAGE=src/python_template
+ROOT_DIR=bert-score-api
+PACKAGE=src/bert_score_api
 PYTHON = python
 PYTHON_VERSION=3.11
 DOC_DIR=./docs
 TEST_DIR=./tests
 TEST_MARKER=placeholder
 TEST_OUTPUT_DIR=tests_outputs
-PRECOMMIT_FILE_PATHS=./python_template/__init__.py
-PROFILE_FILE_PATH=./python_template/__init__.py
-DOCKER_IMAGE=python-template
+PRECOMMIT_FILE_PATHS=./bert_score_api/__init__.py
+PROFILE_FILE_PATH=./bert_score_api/__init__.py
+DOCKER_IMAGE=bert-score-api
 DOCKER_TARGET=development
 
 # TODO: add source for rye

README.md

@@ -1,4 +1,4 @@
-# Python Template
+# BERT Score API
 
 ## Project Structure
 
@@ -33,19 +33,19 @@ make -s install
 
 ```bash
 # Development build (800 MB)
-docker build --tag python-template --file docker/Dockerfile --target development .
+docker build --tag bert-score-api --file docker/Dockerfile --target development .
 
 # Production build (145 MB)
-docker build --tag python-template --file docker/Dockerfile --target production .
+docker build --tag bert-score-api --file docker/Dockerfile --target production .
 ```
 
 - To run command inside the container:
 
 ```bash
-docker run -it python-template:latest bash
+docker run -it bert-score-api:latest bash
 
 # Temporary container
-docker run --rm -it python-template:latest bash
+docker run --rm -it bert-score-api:latest bash
 ```
 
 ## IDE Setings

docker-compose.yml

@@ -1,16 +1,16 @@
 version: "3.9"
 
 services:
-  python-template-dev:
-    image: python-template-dev:latest
+  bert-score-api-dev:
+    image: bert-score-api-dev:latest
     build:
       context: .
       dockerfile: docker/Dockerfile
       target: development
     # ports:
     #   - 8080:8080
-  python-template-prod:
-    image: python-template-prod:latest
+  bert-score-api-prod:
+    image: bert-score-api-prod:latest
     build:
       context: .
       dockerfile: docker/Dockerfile

docs/index.md

@@ -1,5 +1,5 @@
 This site contains the project documentation for the
-`python_template` project.
+`bert_score_api` project.
 
 ## Table Of Contents
 

docs/reference.md

@@ -1,6 +1,6 @@
 This part of the project documentation focuses on
 an **information-oriented** approach. Use it as a
 reference for the technical implementation of the
-`python_template` project code.
+`bert_score_api` project code.
 
-::: python_template
+::: bert_score_api

mkdocs.yml

@@ -1,8 +1,8 @@
-site_name: Python Template
+site_name: Bert Score Api
 site_dir: public
-site_url: https://github.com/ilkersigirci/python-template
-# repo_url: https://gitlab.com/ilkersigirci/python-template # # For GitLab
-repo_url: https://ilkersigirci.github.io/python-template/ # For GitHub
+site_url: https://github.com/ilkersigirci/bert-score-api
+# repo_url: https://gitlab.com/ilkersigirci/bert-score-api # # For GitLab
+repo_url: https://ilkersigirci.github.io/bert-score-api/ # For GitHub
 # repo_name: GitLab
 repo_name: GitHub
 

pyproject.toml

@@ -1,21 +1,22 @@
 [project]
-name = "python_template"
+name = "bert_score_api"
 version = "0.0.0"
-description = "Python Template"
+description = "Bert Score API"
 
 # NOTE: Overwrites .python-version
 # requires-python = ">=3.11,<3.13"
 
 authors = [
-    {name = "template", email = "template@github.com"},
+    {name = "Ilker SIGIRCI", email = "sigirci.ilker@gmail.com"},
 ]
 maintainers = [
-    {name = "template", email = "template@github.com"},
+    {name = "Ilker SIGIRCI", email = "sigirci.ilker@gmail.com"},
 ]
 readme = "README.md"
 
 keywords = [
-    "template"
+    "bert",
+    "fastapi",
 ]
 
 classifiers = [
@@ -63,7 +64,7 @@ name = "default"
 url = "https://pypi.org/simple/"
 
 [tool.rye.scripts]
-placeholder = "python_template.scripts.placeholder:placeholder_script"
+placeholder = "bert_score_api.scripts.placeholder:placeholder_script"
 
 [tool.pytest.ini_options]
 minversion = "7.0.0"
@@ -75,7 +76,7 @@ addopts = [
 #    "--strict-markers",
 #    "--doctest-modules",
     # NOTE: cov is not working with pycharm debugger. Enable it later!
-#    "--cov python_template",
+#    "--cov bert_score_api",
 #    "--cov-report=xml",
 #    "--cov-report html",
 ]
@@ -107,7 +108,7 @@ extend-exclude = [
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["E402", "F401"]
 # "path/to/file.py" = ["E402"]
-# 'python_template/__init__.py' = ['F405', 'F403']
+# 'bert_score_api/__init__.py' = ['F405', 'F403']
 
 # [tool.ruff.flake8-quotes]
 # inline-quotes = "single"
@@ -171,7 +172,7 @@ combine-as-imports = true
 # Read more here: https://mypy.readthedocs.io/en/stable/config_file.html#using-a-pyproject-toml-file
 [tool.mypy]
 # python_version = "3.8"
-files = ["src/python_template"]
+files = ["src/bert_score_api"]
 # exclude = ['^tests/']
 strict = true
 show_error_codes = true
@@ -184,7 +185,7 @@ ignore_missing_imports = true
 check_untyped_defs = true
 
 [tool.coverage.run]
-source = ['src/python_template']
+source = ['src/bert_score_api']
 branch = true
 context = '${CONTEXT}'
 
@@ -200,7 +201,7 @@ exclude_lines = [
 
 # [tool.coverage.paths]
 # source = [
-#     'src/python_template/',
+#     'src/bert_score_api/',
 # ]
 
 [tool.hatch.metadata]

src/python_template/__init__.py → src/bert_score_api/__init__.py

@@ -3,4 +3,4 @@
 from importlib.metadata import version
 
 # Fetches the version of the package as defined in pyproject.toml
-__version__ = version("python_template")
+__version__ = version("bert_score_api")