update to latest version: v1.0.4

.github/workflows/publish-to-pypi.yml

@@ -10,6 +10,7 @@ name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
 
 on:
   push:
+    branches: [main]
 
 permissions:
   contents: read

README.md

@@ -20,7 +20,7 @@ Install the File Security SDK package with pip:
 
 ## Obtain an API Key
 
-The File Security SDK requires a valid API Key provided as parameter to the SDK client object. It can accept Trend Vision One API keys. 
+The File Security SDK requires a valid API Key provided as parameter to the SDK client object. It can accept Trend Vision One API keys.
 
 When obtaining the API Key, ensure that the API Key is associated with the region that you plan to use. It is important to note that Trend Vision One API Keys are associated with different regions, please refer to the region flag below to obtain a better understanding of the valid regions associated with the respective API Key.
 
@@ -29,9 +29,9 @@ If you plan on using a Trend Vision One region, be sure to pass in region parame
 1. Login to the Trend Vision One.
 2. Create a new Trend Vision One API key:
 
-* Navigate to the Trend Vision One User Roles page.
-* Verify that there is a role with the "Run file scan via SDK" permissions enabled. If not, create a role by clicking on "Add Role" and "Save" once finished.
-* Directly configure a new key on the Trend Vision One API Keys page, using the role which contains the "Run file scan via SDK" permission. It is advised to set an expiry time for the API key and make a record of it for future reference.
+- Navigate to the Trend Vision One User Roles page.
+- Verify that there is a role with the "Run file scan via SDK" permissions enabled. If not, create a role by clicking on "Add Role" and "Save" once finished.
+- Directly configure a new key on the Trend Vision One API Keys page, using the role which contains the "Run file scan via SDK" permission. It is advised to set an expiry time for the API key and make a record of it for future reference.
 
 ## Run SDK
 

amaas/_version.py

@@ -1 +1 @@
-__version__ = "1.0.2"
+__version__ = "1.0.4"

amaas/grpc/__init__.py

@@ -77,7 +77,7 @@ def _generate_messages(pipeline: _Pipeline, data_reader: BinaryIO, stats: dict)
                 stage=scan_pb2.STAGE_RUN,
                 file_name=None,
                 rs_size=0,
-                offset=data_reader.tell(),
+                offset=message.offset,
                 chunk=chunk)
 
             stats["total_upload"] = stats.get(

amaas/grpc/aio/__init__.py

@@ -79,7 +79,7 @@ async def _scan_data(channel: grpc.Channel, data_reader: BinaryIO, size: int, id
                     stage=scan_pb2.STAGE_RUN,
                     file_name=None,
                     rs_size=0,
-                    offset=data_reader.tell(),
+                    offset=response.offset,
                     chunk=chunk)
 
                 stats["total_upload"] = stats.get(

examples/README.md

@@ -7,9 +7,9 @@ After completing a scan, [File Security displays scan results](https://docs.tren
 ## Procedure
 
 - If File Security indicates a file contains malware, you can take the following actions:
-   - Quarantine the file. See a [AWS quarantine example](https://github.com/trendmicro/tm-v1-fs-python-sdk/blob/main/examples/aws_quarantine.py).
-   - Send notification messages using:
-      - Slack
-      - Email
-      - Microsoft Teams
-- If File Security does not find malware in a file, you can promote the file.
+  - Quarantine the file. See a [AWS quarantine example](https://github.com/trendmicro/tm-v1-fs-python-sdk/blob/main/examples/aws_quarantine.py).
+  - Send notification messages using:
+    - Slack
+    - Email
+    - Microsoft Teams
+- If File Security does not find malware in a file, you can promote the file.

setup.py

@@ -13,26 +13,26 @@
         r"__version__\s+=\s+[\"\']([^\"\']+)[\"\']", f.read()
     ).group(1)
 
-setup(install_requires=['grpcio==1.51.3', 'protobuf==4.22.0'],
-      name="visionone-filesecurity",
-      version=package_version,
-      author="Trend Micro VisionOne File Security Team",
-      description="Trend Micro VisionOne File Security SDK for python",
-      long_description=long_description,
-      long_description_content_type="text/markdown",
-      url="https://github.com/trendmicro/tm-v1-fs-python-sdk",
-      packages=find_namespace_packages(exclude=['tests*', 'examples']),
-      package_data={'amaas': ['grpc/protos/*']},
-      include_package_data=True,
-      classifiers=[
-          'Programming Language :: Python',
-          'Programming Language :: Python :: 3',
-          'Programming Language :: Python :: 3.7',
-          'Programming Language :: Python :: 3.8',
-          'Programming Language :: Python :: 3.9',
-          'Programming Language :: Python :: 3.10',
-          'Programming Language :: Python :: 3.11',
-          "License :: OSI Approved :: MIT License",
-],
-    python_requires='>=3.7',
+setup(
+    name="visionone-filesecurity",
+    version=package_version,
+    author="Trend Micro VisionOne File Security Team",
+    description="Trend Micro VisionOne File Security SDK for python",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/trendmicro/tm-v1-fs-python-sdk",
+    packages=find_namespace_packages(exclude=["tests*", "examples"]),
+    package_data={"amaas": ["grpc/protos/*"]},
+    include_package_data=True,
+    classifiers=[
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "License :: OSI Approved :: MIT License",
+    ],
+    python_requires=">=3.7",
 )

tools/Makefile

@@ -1,6 +1,3 @@
-# ROOT_DIR := $(abspath ../../)
-# include $(ROOT_DIR)/build-scripts/variables.mk
-
 PIPY_URL ?= https://upload.pypi.org/legacy/
 TOKEN ?=
 
@@ -15,8 +12,7 @@ build: clean
 	pipenv run python setup.py sdist bdist_wheel
 
 upload:
-	#pipenv run twine upload ./dist/*.whl
 	pipenv run twine upload --repository-url $(PIPY_URL) -u __token__ -p $(TOKEN) ./dist/*.whl --skip-existing
 
 clean:
-	@rm -rf dist build amaas/*.egg-info amaas/grpc/protos/
+	@rm -rf dist build *.egg-info amaas/grpc/protos/