nft_storage removed (#261)

* del : nft_storage method removed

* del : Gateway enum removed

* del : nft_upload_test.py removed

* fix : test.yml updated

* doc : README.md updated

* fix : params.py updated

* doc : CHANGELOG.md updated

* fix : unused imports removed

* fix : requirements.txt updated

* fix : tests updated

* fix : test.yml updated

* fix : autopep8

* fix : save_fig_buf function coverage

Author: sepandhaghighi

.github/workflows/test.yml

@@ -49,14 +49,8 @@ jobs:
         python otherfiles/requirements-splitter.py
         pip install --upgrade --upgrade-strategy=only-if-needed -r test-requirements.txt
     - name: Test with pytest
-      run: |
-        python -m pytest --ignore-glob="*nft_upload_test.py" test --cov=samila --cov-report=term
-    - name: Test with pytest (+ NFT upload test)
       run: |
         python -m pytest test --cov=samila --cov-report=term
-      env:
-        NFT_STORAGE_API_KEY: ${{ secrets.NFT_STORAGE_API_KEY }}
-      if: matrix.python-version == env.TEST_PYTHON_VERSION && matrix.os == env.TEST_OS
     - name: Version check
       run: |
         python otherfiles/version_check.py

CHANGELOG.md

@@ -11,9 +11,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 	2. `F2_VS_F1F2`
 ### Changed
 - `README.md` updated
+- `demo.ipynb` updated
 - Test system modified
 - `Python 3.6` support dropped
 - Python typing features added to all modules
+### Removed
+- `nft_storage` method
+- `Gateway` enum
 ## [1.5] - 2025-01-22
 ### Added
 - 3 new generation modes

README.md

@@ -245,38 +245,6 @@ You can make your custom color map and use it in Samila.
 ```
 <img src="https://github.com/sepandhaghighi/samila/raw/master/otherfiles/images/5.png">	
 
-### NFT.storage
-Upload generated image directly to [NFT.storage](https://NFT.storage)
-
-```pycon
->>> g.nft_storage(api_key="YOUR_API_KEY", timeout=5000)
-{'status': True, 'message': 'FILE_LINK'}
-```
-
-You can also upload your config/data to nft storage as follows:
-```pycon
->>> g.nft_storage(api_key="API_KEY", upload_config=True)
-{'status': {'image': True, 'config':True}, 'message': {'image':'IMAGE_FILE_LINK', 'config':'CONFIG_FILE_LINK'}
-```
-or
-```pycon
->>> g.nft_storage(api_key="API_KEY", upload_data=True)
-{'status': {'image': True, 'data':True}, 'message': {'image':'IMAGE_FILE_LINK', 'data':'DATA_FILE_LINK'}
-```
-
-You have the option to choose a specific IPFS gateway:
-```pycon
->>> from samila import Gateway
->>> g.nft_storage(api_key="API_KEY", upload_data=True, gateway=Gateway.DWEB)
-{'status': {'image': True, 'data':True}, 'message': {'image':'IMAGE_FILE_LINK', 'data':'DATA_FILE_LINK'}
-```
-
-
-⚠️ This method is deprecated and may be removed in future releases
-
-ℹ️ Default timeout is `3000` seconds
-
-ℹ️ Default gateway is `IPFS_IO`
 
 ### Save image
 Save generated image.

examples/demo.ipynb

@@ -472,74 +472,6 @@
     "g1.generate()\n",
     "g1.plot()"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## NFT.storage"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Upload generated image directly to [NFT.storage](https://nft.storage)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "g1.nft_storage(api_key=\"YOUR_API_KEY\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "g1.nft_storage(api_key=\"YOUR_API_KEY\", timeout=5000)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can also upload your config/data to nft storage as follows:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "g1.nft_storage(api_key=\"YOUR_API_KEY\", upload_config=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "g1.nft_storage(api_key=\"YOUR_API_KEY\", upload_data=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "⚠️ This method is deprecated and may be removed in future releases\n",
-    "\n",
-    "ℹ️ Default timeout is `3000` seconds\n",
-    "\n",
-    "ℹ️ Default gateway is `IPFS_IO`"
-   ]
   }
  ],
  "metadata": {

requirements.txt

@@ -1,4 +1,3 @@
 matplotlib>=3.0.0
-requests>=2.20.0
 art>=1.8
 Pillow>=6.2

samila/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """Samila modules."""
 from .genimage import GenerativeImage
-from .params import Projection, GenerateMode, Marker, Gateway, VALID_COLORS, SAMILA_VERSION
+from .params import Projection, GenerateMode, Marker, VALID_COLORS, SAMILA_VERSION
 from .errors import samilaDataError, samilaGenerateError
 __version__ = SAMILA_VERSION

samila/functions.py

@@ -3,7 +3,6 @@
 from typing import Callable, Tuple, Dict, Generator, List
 from typing import Any, Union, Iterable
 import sys
-import requests
 import io
 import os
 import re
@@ -12,14 +11,14 @@
 import matplotlib
 from PIL import Image
 from functools import wraps
-from .params import Projection, GenerateMode, Marker, Gateway
+from .params import Projection, GenerateMode, Marker
 from .params import SAMILA_VERSION
 from .params import DEFAULT_MARKER, DEFAULT_START, DEFAULT_STOP, DEFAULT_STEP, DEFAULT_COLOR, DEFAULT_IMAGE_SIZE, DEFAULT_DEPTH
 from .params import DEFAULT_CMAP_NAME, DEFAULT_CMAP_RANGE, DEFAULT_ROTATION, DEFAULT_GENERATE_MODE
 from .params import DEFAULT_BACKGROUND_COLOR, DEFAULT_SPOT_SIZE, DEFAULT_PROJECTION, DEFAULT_ALPHA, DEFAULT_LINEWIDTH
-from .params import VALID_COLORS, HEX_COLOR_PATTERN, NFT_STORAGE_API, OVERVIEW
+from .params import VALID_COLORS, HEX_COLOR_PATTERN, OVERVIEW
 from .params import DATA_TYPE_ERROR, DATA_FORMAT_ERROR, CONFIG_TYPE_ERROR, CONFIG_FORMAT_ERROR, PLOT_DATA_ERROR, CONFIG_NO_STR_FUNCTION_ERROR
-from .params import NO_FIG_ERROR_MESSAGE, FIG_SAVE_SUCCESS_MESSAGE, NFT_STORAGE_SUCCESS_MESSAGE, SAVE_NO_DATA_ERROR
+from .params import NO_FIG_ERROR_MESSAGE, FIG_SAVE_SUCCESS_MESSAGE, SAVE_NO_DATA_ERROR
 from .params import INVALID_COLOR_TYPE_ERROR, COLOR_SIZE_ERROR
 from .params import BOTH_COLOR_COMPLEMENT_WARNING, COLOR_NOT_FOUND_WARNING, DEPRECATION_WARNING
 from .params import DATA_SAVE_SUCCESS_MESSAGE, SEED_LOWER_BOUND, SEED_UPPER_BOUND
@@ -508,41 +507,6 @@ def _GI_initializer(g: "GenerativeImage", function1: Callable, function2: Callab
     g.missed_points_number = 0
 
 
-def nft_storage_upload(
-        api_key: str,
-        data: bytes,
-        timeout: int,
-        gateway: Gateway) -> Dict[str, Any]:
-    """
-    Upload file to nft.storage.
-
-    :param api_key: API key
-    :param data: image data
-    :param timeout: upload timeout (in seconds)
-    :param gateway: IPFS gateway
-    """
-    result = {"status": True, "message": NFT_STORAGE_SUCCESS_MESSAGE}
-    try:
-        headers = {'Authorization': 'Bearer {0}'.format(api_key)}
-        response = requests.post(
-            url=NFT_STORAGE_API,
-            data=data,
-            headers=headers,
-            timeout=timeout)
-        response_json = response.json()
-        if response_json["ok"]:
-            result["message"] = gateway.value.format(
-                response_json['value']['cid'])
-            return result
-        result["status"] = False
-        result["message"] = response_json["error"]["message"]
-        return result
-    except Exception as e:
-        result["status"] = False
-        result["message"] = str(e)
-        return result
-
-
 def save_data_file(g: "GenerativeImage", file_adr: str) -> Dict[str, Any]:
     """
     Save data as file.
@@ -682,7 +646,7 @@ def save_fig_file(figure: matplotlib.figure.Figure, file_adr: str, depth: float)
         return result
 
 
-def save_fig_buf(figure: matplotlib.figure.Figure, depth: float) -> Dict[str, Any]:
+def save_fig_buf(figure: matplotlib.figure.Figure, depth: float) -> Dict[str, Any]: # pragma: no cover
     """
     Save figure as buffer.
 

samila/genimage.py

@@ -3,18 +3,17 @@
 from typing import List, Tuple, Dict, Callable
 from typing import Union, Iterable
 from typing import Any
-import json
 import random
 import io
 import gc
 import itertools
 import matplotlib
 import matplotlib.pyplot as plt
 from .functions import _GI_initializer, plot_params_filter, generate_params_filter, save_params_filter
-from .functions import get_config, get_data, get_python_version
-from .functions import float_range, save_data_file, save_fig_file, save_fig_buf, save_config_file
-from .functions import load_data, load_config, random_equation_gen, nft_storage_upload
-from .functions import set_background, rotate, deprecated
+from .functions import get_python_version
+from .functions import float_range, save_data_file, save_fig_file, save_config_file
+from .functions import load_data, load_config, random_equation_gen
+from .functions import set_background, rotate
 from .params import *
 from warnings import warn, catch_warnings, simplefilter
 
@@ -216,56 +215,6 @@ def plot(
         ax = rotate(fig, ax, self.rotation)
         self.fig = fig
 
-    @deprecated
-    def nft_storage(
-            self,
-            api_key: str,
-            upload_data: bool = False,
-            upload_config: bool = False,
-            depth: float = None,
-            timeout: int = 3000,
-            gateway: Gateway = Gateway.IPFS_IO) -> Dict[str, Any]:
-        """
-        Upload image to nft.storage.
-
-        :param api_key: API key
-        :param upload_data: upload data flag
-        :param upload_config: upload config flag
-        :param depth: image depth
-        :param timeout: upload timeout (in seconds)
-        :param gateway: IPFS gateway
-        """
-        save_params_filter(self, depth)
-        response = save_fig_buf(self.fig, self.depth)
-        if not response["status"]:
-            return {"status": False, "message": response["message"]}
-        buf = response["buffer"]
-        response = nft_storage_upload(
-            api_key=api_key,
-            data=buf.getvalue(),
-            timeout=timeout,
-            gateway=gateway)
-        if upload_config == False and upload_data == False:
-            return response
-        result = {key: {'image': value} for key, value in response.items()}
-        if upload_config:
-            response = nft_storage_upload(
-                api_key=api_key,
-                data=json.dumps(get_config(self)),
-                timeout=timeout,
-                gateway=gateway)
-            for key, value in response.items():
-                result[key]['config'] = value
-        if upload_data:
-            response = nft_storage_upload(
-                api_key=api_key,
-                data=json.dumps(get_data(self)),
-                timeout=timeout,
-                gateway=gateway)
-            for key, value in response.items():
-                result[key]['data'] = value
-        return result
-
     def save_image(self, file_adr: str, depth: float = None) -> Dict[str, Any]:
         """
         Save generated image.

samila/params.py

@@ -36,8 +36,6 @@
         matplotlib.colors.BASE_COLORS,
         **matplotlib.colors.CSS4_COLORS))
 HEX_COLOR_PATTERN = r'^#(?:[0-9a-fA-F]{3}){1,2}$'
-NFT_STORAGE_API = "https://api.nft.storage/upload"
-NFT_STORAGE_SUCCESS_MESSAGE = "Everything seems good."
 FIG_SAVE_SUCCESS_MESSAGE = "Everything seems good."
 DATA_SAVE_SUCCESS_MESSAGE = "Everything seems good."
 NO_FIG_ERROR_MESSAGE = "No figure was found. First run `generate` and `plot` methods."
@@ -99,36 +97,6 @@ class GenerateMode(Enum):
     RANDOM = "random"
 
 
-class Gateway(Enum):
-    """
-    IPFS gateway class.
-
-    >>> import samila
-    >>> gateway = samila.Gateway.IPFS_IO
-    """
-
-    CID = "{0}"
-    IPFS_IO = "https://ipfs.io/ipfs/{0}"
-    GATEWAY_IPFS_IO = "https://gateway.ipfs.io/ipfs/{0}"
-    VIA0 = "https://via0.com/ipfs/{0}"
-    CLOUDFLARE_IPFS = "https://cloudflare-ipfs.com/ipfs/{0}"
-    HARDBIN = "https://hardbin.com/ipfs/{0}"
-    PINATA = "https://gateway.pinata.cloud/ipfs/{0}"
-    JORROPO = "https://jorropo.net/ipfs/{0}"
-    DWEB = "https://dweb.link/ipfs/{0}"
-    BEST_PRACTICE = "https://ipfs.best-practice.se/ipfs/{0}"
-    RUNFISSION = "https://ipfs.runfission.com/ipfs/{0}"
-    ARAGON_NETWORK = "https://ipfs.eth.aragon.network/ipfs/{0}"
-    TEXTILE = "https://hub.textile.io/ipfs/{0}"
-    EVERLAND = "https://{0}.ipfs.4everland.io"
-    CF_IPFS = "https://{0}.ipfs.cf-ipfs.com"
-    LITNET = "https://ipfs.litnet.work/ipfs/{0}"
-    JPU = "https://ipfs.jpu.jp/ipfs/{0}"
-    CZIP = "https://ipfs.czip.it/ipfs/{0}"
-    W3S = "https://{0}.ipfs.w3s.link"
-    GW3 = "https://{0}.ipfs.gw3.io"
-
-
 class Projection(Enum):
     """
     Samila Projection type class.