Skip to content

Commit

Permalink
clean documentations from static docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MAfarrag committed Dec 15, 2024
1 parent b66408c commit a02672e
Showing 1 changed file with 0 additions and 41 deletions.
41 changes: 0 additions & 41 deletions docs/source/gcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,6 @@ GCS Class Documentation

The ``GCS`` class provides methods to interact with Google Cloud Storage (GCS), allowing for uploading and downloading files.

.. class:: GCS(project_name, service_key=None)

Initializes the GCS client with the specified project name and optional service key.

:param project_name: The Google Cloud project name.
:type project_name: str
:param service_key: The path to the service account key file (optional).
:type service_key: str, optional

.. method:: upload(file_path, destination)

Uploads a file to GCS.

:param file_path: The path to the file to upload.
:type file_path: str
:param destination: The destination path in GCS.
:type destination: str

**Example**:

.. code-block:: python
gcs_client = GCS('my-gcp-project')
gcs_client.upload_data('/local/path/to/file.txt', 'bucket-name/object-name.txt')
.. method:: download(source, file_path)

Downloads a file from GCS.

:param source: The source path in GCS.
:type source: str
:param file_path: The local path to save the downloaded file.
:type file_path: str

**Example**:

.. code-block:: python
gcs_client = GCS('my-gcp-project')
gcs_client.download_data('bucket-name/object-name.txt', '/local/path/to/save/file.txt')
.. automodule:: unicloud.google_cloud.gcs
:members:
:undoc-members:
Expand Down

0 comments on commit a02672e

Please sign in to comment.