[update] upload pypi and new CLI

Author: NatLee

.editorconfig

@@ -0,0 +1,20 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+charset = utf-8
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{md,mdx}]
+trim_trailing_whitespace = false

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          python setup.py sdist bdist_wheel
+          twine upload --repository pypi dist/*

.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+    branches:
+      - main
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: [3.7, 3.8, 3.9]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install Tox and other packages
+        run: pip install tox
+      - name: Run Tox
+        # Run tox using the version of Python in `PATH`
+        run: tox -e py

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "python.testing.unittestEnabled": false,
+  "python.testing.nosetestsEnabled": false,
+  "python.testing.pytestEnabled": true,
+  "python.envFile": "${workspaceRoot}/vscode.env"
+}

LICENSE

@@ -0,0 +1,4 @@
+include pyproject.toml
+include *.md
+include LICENSE
+recursive-include tests test*.py

MANIFEST.in

@@ -1,18 +1,23 @@
-
 # Blur Generator
 
-Generate blur on image.
+This tool is for generating blur on images.
+
+There are 3 types of blur modes of `motion`, `lens`, or `gaussian`.
+
+We can use the results on model training or something else.
 
-There are 3 types of blur can be used with `motion`, `lens`, or `gaussian`.
+## Installation
 
-We can use the results on model training or something.
+```bash
+pip install blurgenerator
+```
 
 ## Usage
 
 ```bash
-usage: main.py [-h] [--input INPUT] [--output OUTPUT] [--type TYPE] [--motion_blur_size MOTION_BLUR_SIZE]
-               [--motion_blur_angle MOTION_BLUR_ANGLE] [--lens_radius LENS_RADIUS] [--lens_components LENS_COMPONENTS]
-               [--lens_exposure_gamma LENS_EXPOSURE_GAMMA] [--gaussian_kernel GAUSSIAN_KERNEL]
+usage: blurgenerator [-h] [--input INPUT] [--output OUTPUT] [--type TYPE] [--motion_blur_size MOTION_BLUR_SIZE] [--motion_blur_angle MOTION_BLUR_ANGLE]
+                     [--lens_radius LENS_RADIUS] [--lens_components LENS_COMPONENTS] [--lens_exposure_gamma LENS_EXPOSURE_GAMMA]
+                     [--gaussian_kernel GAUSSIAN_KERNEL]
 
 optional arguments:
   -h, --help            show this help message and exit
@@ -33,27 +38,47 @@ optional arguments:
                         Kernel for gaussian. Default is 100.
 ```
 
-## Results
+## Example and Result
 
-* Original image
+- Original image
 
 ![original image](./doc/test.png)
 
-* Motion blur
+- Motion blur
+
+`blurgenerator --type motion --input ./doc/test.png --output ./doc/motion.png`
 
-`python3 main.py --type motion --input ./doc/test.png --output ./doc/motion.png`
+```python
+import cv2
+from blurgenerator import motion_blur
+img = cv2.imread('test.png')
+result = motion_blur(img, size=100, angle=30)
+```
 
 ![motion blur image](./doc/motion.png)
 
-* Lens blur
+- Lens blur
+
+`blurgenerator--type lens --input ./doc/test.png --output ./doc/lens.png`
 
-`python3 main.py --type lens --input ./doc/test.png  --output ./doc/lens.png`
+```python
+import cv2
+from blurgenerator import lens_blur
+img = cv2.imread('test.png')
+result = lens_blur(img, radius=5, components=4, exposure_gamma=2)
+```
 
 ![lens blur image](./doc/lens.png)
 
-* Gaussian blur
+- Gaussian blur
 
-`python3 main.py --type gaussian --input ./doc/test.png --output ./doc/gaussian.png`
+`blurgenerator --type gaussian --input ./doc/test.png --output ./doc/gaussian.png`
 
-![gaussian blur image](./doc/gaussian.png)
+```python
+import cv2
+from blurgenerator import gaussian_blur
+img = cv2.imread('test.png')
+result = gaussian_blur(img, 100)
+```
 
+![gaussian blur image](./doc/gaussian.png)

README.md

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=46.4.0", "wheel"]
+build-backend = "setuptools.build_meta"

pyproject.toml

@@ -0,0 +1,3 @@
+[metadata]
+version = attr: blurgenerator.__version__
+license_files = LICENSE

requirements.txt

@@ -0,0 +1,50 @@
+import setuptools
+
+with open('README.md', 'r', encoding='utf-8') as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name='BlurGenerator',
+    author='Nat Lee',
+    author_email='[email protected]',
+    description='Fast generate blur image.',
+    keywords='blur, generator, blur-image, cli',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url='https://github.com/NatLee/Blur-Generator',
+    project_urls={
+        'Documentation': 'https://github.com/NatLee/Blur-Generator',
+        'Bug Reports': 'https://github.com/NatLee/Blur-Generator/issues',
+        'Source Code': 'https://github.com/NatLee/Blur-Generator',
+        # 'Funding': '',
+        # 'Say Thanks!': '',
+    },
+    package_dir={'': 'src'},
+    packages=setuptools.find_packages(where='src'),
+    classifiers=[
+        # see https://pypi.org/classifiers/
+        'Development Status :: 5 - Production/Stable',
+
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Build Tools',
+
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3 :: Only',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.7',
+    install_requires=['opencv-python', 'scipy'],
+    extras_require={
+        'dev': ['check-manifest'],
+        # 'test': ['coverage'],
+    },
+    entry_points={
+        'console_scripts': [
+            'blurgenerator=blurgenerator.cli:main'
+        ]
+    }
+)

setup.cfg

@@ -1,7 +1,10 @@
 """
 Blur maker init
 """
+__version__ = "1.0.0"
 
 from .motion_blur import motion_blur
 from .lens_blur import lens_blur
 from .gaussian_blur import gaussian_blur
+
+from .cli import main

setup.py

@@ -1,17 +1,14 @@
 """
 Blur Maker
-
 """
 import argparse
-
 from pathlib import Path
 
 import cv2
 
-from blur_tools import motion_blur, lens_blur, gaussian_blur
-
+from blurgenerator import motion_blur, lens_blur, gaussian_blur
 
-if __name__ == "__main__":
+def main():
 
     parser = argparse.ArgumentParser()
 
@@ -40,23 +37,23 @@
                 img = img / 255.
 
                 if args.type not in ['motion', 'lens', 'gaussian']:
-                    print('No type has been selected. Please specific `motion`, `lens`, or `gaussian`.')
+                    print('----- No type has been selected. Please specific `motion`, `lens`, or `gaussian`.')
                 else:
                     if args.type == 'motion':
                         result = motion_blur(img, size=args.motion_blur_size, angle=args.motion_blur_angle)
 
                     elif args.type == 'lens':
-                        result = lens_blur(img, radius=5, components=4, exposure_gamma=2)
+                        result = lens_blur(img, radius=args.lens_radius, components=args.lens_components, exposure_gamma=args.lens_exposure_gamma)
 
                     elif args.type == 'gaussian':
-                        result = gaussian_blur(img, 100)
+                        result = gaussian_blur(img, args.gaussian_kernel)
 
                     cv2.imwrite(args.output, result*255)
 
             else:
-                print('Only support common types of image `.jpg` and `.png`.')
+                print('----- Only support common types of image `.jpg` and `.png`.')
 
         else:
-            print('File not exists!')
+            print('----- File not exists!')
     else:
-        print('Please specific image for input.')
+        print('----- Please specific image for input.')

blur_tools/__init__.py src/blurgenerator/__init__.py

@@ -0,0 +1,23 @@
+import unittest
+import numpy as np
+from blurgenerator import motion_blur, lens_blur, gaussian_blur
+
+class TestBlurGenerator(unittest.TestCase):
+
+    def test_motion_blur(self):
+        rgb = np.random.randint(255, size=(50, 50, 3),dtype=np.uint8)
+        blur_img = motion_blur(rgb)
+        self.assertFalse(np.array_equal(rgb, blur_img))
+
+    def test_lens_blur(self):
+        rgb = np.random.randint(255, size=(50, 50, 3),dtype=np.uint8)
+        blur_img = lens_blur(rgb)
+        self.assertFalse(np.array_equal(rgb, blur_img))
+
+    def test_gaussian_blur(self):
+        rgb = np.random.randint(255, size=(50, 50, 3),dtype=np.uint8)
+        blur_img = gaussian_blur(rgb, kernel=3)
+        self.assertFalse(np.array_equal(rgb, blur_img))
+
+if __name__ == '__main__':
+    unittest.main()

main.py src/blurgenerator/cli.py

@@ -0,0 +1,13 @@
+[tox]
+envlist = py{37,38,39}
+minversion = 3.3.0
+isolated_build = true
+
+[testenv]
+deps =
+    check-manifest >= 0.42
+    pytest
+commands =
+    check-manifest --ignore 'tox.ini,tests/**,.editorconfig,vscode.env,.vscode/**'
+    python setup.py check -m -s
+    pytest tests {posargs}

blur_tools/gaussian_blur.py src/blurgenerator/gaussian_blur.py

@@ -0,0 +1 @@
+PYTHONPATH=/;src/;${PYTHONPATH}