fix: change repository name (#17)

Signed-off-by: Pratiksha Sankhe <[email protected]>
elixir-cloud-aai · Sep 3, 2024 · 4f7c103 · 4f7c103
1 parent cb97130
commit 4f7c103
Show file tree

Hide file tree

Showing 31 changed files with 140 additions and 133 deletions.
diff --git a/.cruft.json b/.cruft.json
@@ -8,8 +8,8 @@
       "author_email": "[email protected]",
       "development_status": "1 - Planning",
       "short_description": "File handler utilizing TUS and MinIO with DRS-Filer integration.",
-      "project_name": "tus_storagehandler",
-      "project_slug": "tus_storagehandler",
+      "project_name": "cloud-storage-handler",
+      "project_slug": "cloud_storage_handler",
       "github_username": "elixir-cloud-aai",
       "python_version": "3.11",
       "add_script": "y",

diff --git a/.github/ISSUE_TEMPLATE/general-purpose.md b/.github/ISSUE_TEMPLATE/general-purpose.md
@@ -46,4 +46,4 @@ bug in -->
 - Operating System and version (desktop or mobile):
 - Link to your project:
 
-[issue-tracker]: https://github.com/elixir-cloud-aai/tus_storagehandler/issues
+[issue-tracker]: https://github.com/elixir-cloud-aai/cloud-storage-handler/issues
diff --git a/.github/workflows/code_quality.yaml b/.github/workflows/code_quality.yaml
@@ -80,5 +80,5 @@ jobs:
           poetry-export-options: "--with=code_quality --with=types"
 
       - name: Check types
-        run: poetry run mypy tus_storagehandler/
+        run: poetry run mypy cloud_storage_handler/
 ...
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -29,7 +29,7 @@ jobs:
         run: |
           poetry run sphinx-apidoc  \
             -o /tmp/docs/source/pages \
-            tus_storagehandler/
+            cloud_storage_handler/
 
       - name: Compare current docs with latest docs
         id: check_docs_diff

diff --git a/.github/workflows/run-application.yaml b/.github/workflows/run-application.yaml
@@ -35,7 +35,7 @@ jobs:
 
       - name: Start server in the background
         run: |
-          tus_storagehandler &
+          cloud_storage_handler &
           echo $! > server.pid
 
       - name: Run tests

diff --git a/.github/workflows/vulnerability.yaml b/.github/workflows/vulnerability.yaml
@@ -26,7 +26,7 @@ jobs:
           poetry-export-options: "--only=vulnerability"
 
       - name: Check code vulnerabilities with bandit
-        run: poetry run bandit -c pyproject.toml -r tus_storagehandler/
+        run: poetry run bandit -c pyproject.toml -r cloud_storage_handler/
 
   dependency-vulnerabilities:
     name: Dependencies

diff --git a/Makefile b/Makefile
@@ -25,7 +25,7 @@ help:
 
 	@echo "Environment Management --------------------------------------------------------"
 	@echo "  \033[1m\033[35mclean-venv\033[0m \033[37m(cv)\033[0m: \033[36mRemove virtual environment.\033[0m"
-	@echo "  \033[1m\033[35minstall\033[0m \033[37m(i)\033[0m: \033[36mInstall dependencies and tus_storagehandler.\033[0m"
+	@echo "  \033[1m\033[35minstall\033[0m \033[37m(i)\033[0m: \033[36mInstall dependencies and cloud_storage_handler.\033[0m"
 	@echo "  \033[1m\033[35mvenv\033[0m \033[37m(v)\033[0m: \033[36mCreate virtual environment.\033[0m\n"
 
 	@echo "Miscellaneous -----------------------------------------------------------------"
@@ -50,7 +50,7 @@ cv: clean-venv
 .PHONY: docs
 docs:
 	@echo "\nGenerating project documentation ++++++++++++++++++++++++++++++++++++++++++++++\n"
-	@poetry run sphinx-apidoc -f -o docs/source/pages tus_storagehandler
+	@poetry run sphinx-apidoc -f -o docs/source/pages cloud_storage_handler
 	@cd docs && make html
 	@echo "\nSummary ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n"
 	@echo "Documentation generated successfully."
@@ -90,7 +90,7 @@ pc: precommit-check
 security:
 	@echo "\nRunning security scans using bandit and safety ++++++++++++++++++++++++++++++++\n"
 	@poetry run safety check --full-report
-	@poetry run bandit -c pyproject.toml -r tus_storagehandler
+	@poetry run bandit -c pyproject.toml -r cloud_storage_handler
 
 .PHONY: s
 s: security
@@ -106,7 +106,7 @@ t: test
 .PHONY: type-check
 type-check:
 	@echo "\nPerforming type checking with mypy ++++++++++++++++++++++++++++++++++++++++++++\n"
-	@poetry run mypy tus_storagehandler
+	@poetry run mypy cloud_storage_handler
 
 .PHONY: tc
 tc: type-check

diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
 [![Bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://bandit.readthedocs.io/en/latest/)
-[![codecov](https://codecov.io/gh/elixir-cloud-aai/tus-storagehandler/branch/main/graph/badge.svg)](https://codecov.io/gh/elixir-cloud-aai/tus-storagehandler)
+[![codecov](https://codecov.io/gh/elixir-cloud-aai/cloud-storage-handler/branch/main/graph/badge.svg)](https://codecov.io/gh/elixir-cloud-aai/cloud-storage-handler)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)][code-of-conduct]
-[![Documentation Status](https://readthedocs.org/projects/tus_storagehandler/badge/?version=latest)](https://tus_storagehandler.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/cloud-storage-handler/badge/?version=latest)](https://cloud-storage-handler.readthedocs.io/en/latest/?badge=latest)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
 [![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/)
-[![GitHub contributors](https://img.shields.io/github/contributors/elixir-cloud-aai/tus-storagehandler)](https://github.com/elixir-cloud-aai/tus-storagehandler/graphs/contributors)
+[![GitHub contributors](https://img.shields.io/github/contributors/elixir-cloud-aai/cloud-storage-handler)](https://github.com/elixir-cloud-aai/cloud-storage-handler/graphs/contributors)
 [![Ruff](https://img.shields.io/badge/linter%20&%20formatter-ruff-000000.svg)](https://docs.astral.sh/ruff/)
 [![Safety](https://img.shields.io/badge/security-safety-orange.svg)](https://safetycli.com/product/safety-cli)
 
-# tus-storagehandler
+# Cloud Storage Handler
 
 File handler utilizing TUS and MinIO with DRS-Filer integration.
 
@@ -54,15 +54,15 @@ minio server /data --console-address ":9001"
    To get started, first, clone the repository using the following command:
 
    ```sh
-   git clone https://github.com/elixir-cloud-aai/tus-storagehandler.git
+   git clone https://github.com/elixir-cloud-aai/cloud-storage-handler.git
    ```
 
 1. **Navigate to the package folder**
 
-   Navigate to the folder `tus_storagehandler`:
+   Navigate to the folder `cloud-storage-handler`:
 
    ```sh
-   cd tus_storagehandler
+   cd cloud-storage-handler
    ```
 
 1. **Install Poetry**
@@ -185,8 +185,11 @@ make u
 <!-- markdownlint-disable line-length -->
 
 | **Environment Variable** | **Description** | **Usage** | **Error Handling** |
-|--|--|--|--| 
-| `CSH_FOCA_CONFIG_PATH` | Specifies the path to the configuration file for the FOCA app. | The FOCA app uses this environment variable to locate the configuration file. If not set, it defaults to `dev`. | If the configuration file is not found at the specified or default path, a `FileNotFoundError` will be raised. |
+|--|--|--|--| | `CSH_FOCA_CONFIG_PATH` | Specifies the path to the configuration
+file for the FOCA app. | The FOCA app uses this environment variable to locate
+the configuration file. If not set, it defaults to `dev`. | If the configuration
+file is not found at the specified or default path, a `FileNotFoundError` will
+be raised. |
 
 <!-- markdownlint-enable line-length -->
 
@@ -242,7 +245,7 @@ To get in touch with us, please use one of the following routes:
 [elixir-compute]: https://elixir-europe.org/platforms/compute
 [email]: mailto:[email protected]
 [ga4gh]: https://ga4gh.org/
-[issue-tracker]: https://github.com/elixir-cloud-aai/tus-storagehandler/issues
+[issue-tracker]: https://github.com/elixir-cloud-aai/cloud-storage-handler/issues
 [license]: LICENSE
 [logo-elixir]: images/logo-elixir.svg
 [logo-elixir-cloud-aai]: images/logo-elixir-cloud-aai.svg

diff --git a/tus_storagehandler/__init__.py → cloud_storage_handler/__init__.py b/tus_storagehandler/__init__.py → cloud_storage_handler/__init__.py
diff --git a/tus_storagehandler/api/__init__.py → cloud_storage_handler/api/__init__.py b/tus_storagehandler/api/__init__.py → cloud_storage_handler/api/__init__.py
diff --git a/...toragehandler/api/elixircloud/__init__.py → ...orage_handler/api/elixircloud/__init__.py b/...toragehandler/api/elixircloud/__init__.py → ...orage_handler/api/elixircloud/__init__.py
diff --git a/...gehandler/api/elixircloud/csh/__init__.py → ...e_handler/api/elixircloud/csh/__init__.py b/...gehandler/api/elixircloud/csh/__init__.py → ...e_handler/api/elixircloud/csh/__init__.py
diff --git a/...andler/api/elixircloud/csh/controllers.py → ...andler/api/elixircloud/csh/controllers.py b/...andler/api/elixircloud/csh/controllers.py → ...andler/api/elixircloud/csh/controllers.py
@@ -1,4 +1,4 @@
-"""Cloud Storage Handler controllers."""
+"""ELIXIR's Cloud Storage Handler controllers."""
 
 import logging
 from http import HTTPStatus

diff --git a/tus_storagehandler/api/specs/specs.yaml → cloud_storage_handler/api/specs/specs.yaml b/tus_storagehandler/api/specs/specs.yaml → cloud_storage_handler/api/specs/specs.yaml
@@ -11,7 +11,7 @@ info:
     name: Apache 2.0
     url: >
       https://github.com/elixir-cloud-aai/
-      tus_storagehandler/blob/main/LICENSE
+      cloud-storage-handler/blob/main/LICENSE
 servers:
   - url: /elixircoud/csh/v1
 paths:
@@ -30,7 +30,7 @@ paths:
                 properties:
                   message:
                     type: string
-                    example: "Welcome to Tus Storage Handler API"
+                    example: "Welcome to Cloud Storage Handler API"
         '400':
           description: The request is malformed.
         '500':

diff --git a/tus_storagehandler/exceptions.py → cloud_storage_handler/exceptions.py b/tus_storagehandler/exceptions.py → cloud_storage_handler/exceptions.py
@@ -1,4 +1,4 @@
-"""Tus Storage Handler exceptions."""
+"""ELIXIR's Cloud Storage Handler exceptions."""
 
 from http import HTTPStatus
 
@@ -18,7 +18,7 @@
         "code": HTTPStatus.NOT_FOUND,  # 404
     },
     InternalServerError: {
-        "message": "An internal server error occurred in the tus storage handler",
+        "message": "An internal server error occurred in the cloud storage handler",
         "code": HTTPStatus.INTERNAL_SERVER_ERROR,  # 500
     },
 }
diff --git a/tus_storagehandler/app.py → cloud_storage_handler/main.py b/tus_storagehandler/app.py → cloud_storage_handler/main.py
diff --git a/deployment/config.yaml b/deployment/config.yaml
@@ -24,10 +24,10 @@ security:
 
 api:
     specs:
-        - path: tus_storagehandler/api/specs/specs.yaml
+        - path: cloud_storage_handler/api/specs/specs.yaml
           append: null
           add_operation_fields:
-              x-openapi-router-controller: tus_storagehandler.api.elixircloud.csh.controllers
+              x-openapi-router-controller: cloud_storage_handler.api.elixircloud.csh.controllers
           connexion:
               strict_validation: true
               validate_responses: false
@@ -38,5 +38,5 @@ api:
 exceptions:
     required_members: [['message'], ['code']]
     status_member: ['code']
-    exceptions: tus_storagehandler.exceptions.exceptions
+    exceptions: cloud_storage_handler.exceptions.exceptions
 ...
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,4 +1,4 @@
-Welcome to tus_storagehandler's documentation!
+Welcome to cloud_storage_handler's documentation!
 ===========================================================
 
 .. toctree::

diff --git a/docs/source/pages/cloud_storage_handler.api.elixircloud.csh.rst b/docs/source/pages/cloud_storage_handler.api.elixircloud.csh.rst
@@ -0,0 +1,21 @@
+cloud\_storage\_handler.api.elixircloud.csh package
+===================================================
+
+Submodules
+----------
+
+cloud\_storage\_handler.api.elixircloud.csh.controllers module
+--------------------------------------------------------------
+
+.. automodule:: cloud_storage_handler.api.elixircloud.csh.controllers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cloud_storage_handler.api.elixircloud.csh
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pages/cloud_storage_handler.api.elixircloud.rst b/docs/source/pages/cloud_storage_handler.api.elixircloud.rst
@@ -0,0 +1,18 @@
+cloud\_storage\_handler.api.elixircloud package
+===============================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   cloud_storage_handler.api.elixircloud.csh
+
+Module contents
+---------------
+
+.. automodule:: cloud_storage_handler.api.elixircloud
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pages/cloud_storage_handler.api.rst b/docs/source/pages/cloud_storage_handler.api.rst
@@ -0,0 +1,18 @@
+cloud\_storage\_handler.api package
+===================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   cloud_storage_handler.api.elixircloud
+
+Module contents
+---------------
+
+.. automodule:: cloud_storage_handler.api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pages/cloud_storage_handler.rst b/docs/source/pages/cloud_storage_handler.rst
@@ -0,0 +1,37 @@
+cloud\_storage\_handler package
+===============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   cloud_storage_handler.api
+
+Submodules
+----------
+
+cloud\_storage\_handler.exceptions module
+-----------------------------------------
+
+.. automodule:: cloud_storage_handler.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cloud\_storage\_handler.main module
+-----------------------------------
+
+.. automodule:: cloud_storage_handler.main
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cloud_storage_handler
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pages/modules.rst b/docs/source/pages/modules.rst
@@ -1,7 +1,7 @@
-tus_storagehandler
-==================
+cloud_storage_handler
+=====================
 
 .. toctree::
    :maxdepth: 4
 
-   tus_storagehandler
+   cloud_storage_handler
diff --git a/docs/source/pages/tus_storagehandler.api.elixircloud.csh.rst b/docs/source/pages/tus_storagehandler.api.elixircloud.csh.rst
diff --git a/docs/source/pages/tus_storagehandler.api.elixircloud.rst b/docs/source/pages/tus_storagehandler.api.elixircloud.rst
diff --git a/docs/source/pages/tus_storagehandler.api.rst b/docs/source/pages/tus_storagehandler.api.rst