Merge branch 'master' into develop

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

docsrc/quickstart.rst

@@ -21,7 +21,7 @@ The simplest usage is to change to the folder containing the images with
 
 ::
 
-    cd /folder/wit/images
+    cd /folder/with/images
 
 and type
 

pyimgbatch/__main__.py

@@ -52,9 +52,11 @@ def get_args():
 
     image_manipulation_group = parser.add_argument_group('image manipulation')
     image_manipulation_group.add_argument('--width', type=int,
-                                          default=None, help='...')
+                                          default=None, help='width of the destination image.')
     image_manipulation_group.add_argument('--height', type=int,
-                                          default=None, help='...')
+                                          default=None, help='height of the destination image.')
+    image_manipulation_group.add_argument('--resample', type=str, choices=["none", "bilinear", "bicubic", "hamming", "box", "antialias"],
+                                          default="antialias", help='resample arlgorithm used for resizing, defaults to "antialias"')
 
     return parser.parse_args()
 

pyimgbatch/pyimgbatch.py

@@ -14,8 +14,6 @@
 from PIL import Image
 from PIL import ImageCms
 
-# from .helper import to_int_or_none
-
 
 WEBSETS = {'@2x': 2, '@3x': 3}
 SUPPORTED_FILES = ['*.jpg', '*.jpeg', '*.png', '*.tif']
@@ -51,12 +49,13 @@ class CONFKEY(metaclass=CONSTANTS):
 
 class OPTIONKEY(metaclass=CONSTANTS):
     SOURCE, DEST = 'source', 'dest'
-    CONFIGFILE = 'configfile'
+    # CONFIGFILE = 'configfile'
     OVERRIDE = 'override'
     NOPROGRESS = 'no_progress'
     DEBUG = 'debug'
     PROJECTS, CONFIGS = 'projects', 'configs'
     NAME = 'name'
+    PROJECT = 'project'
 
 
 class Entries(object):
@@ -94,13 +93,13 @@ def source(self):
     def dest(self):
         return self._value(OPTIONKEY.DEST, OPTIONKEY.DEST)
 
-    @property  # TODO: replace
-    def configfile(self):
-        return self._value(OPTIONKEY.CONFIGFILE, 'imagebatch.json')
+    # @property  # TODO: replace
+    # def configfile(self):
+    #     return self._value(OPTIONKEY.CONFIGFILE, 'imagebatch.json')
 
     @property
     def project_file_name(self):
-        return self._value('project', 'pyimgbatch.json')  # TODO: Constants
+        return self._value(OPTIONKEY.PROJECT, 'pyimgbatch.json')
 
     @property
     def override(self):
@@ -365,14 +364,7 @@ def exec(self):
 
 
 class Size(object):
-    """[summary]
 
-    :param object: [description]
-    :type object: [type]
-    :raises Exception: [description]
-    :return: [description]
-    :rtype: [type]
-    """
     def __init__(self, *args):
         if len(args) == 1 and type(args[0]) is tuple:
             # TODO: to_int_or_none for tuple too
@@ -434,10 +426,6 @@ class Out:
     def out(cls, *args):
         cls.outfunction(*args)
 
-    # @classmethod
-    # def __call__(cls, *args):
-    #     cls.out(*args)
-
     @classmethod
     def init_project_bar(cls, disable=True):
         cls.project_bar = ProgressBar(1, disable=disable)
@@ -457,15 +445,6 @@ def __del__(cls):
 
 
 def to_int_or_none(value, multiplier=1):
-    """[summary]
-
-    :param value: [description]
-    :type value: [type]
-    :param multiplier: [description], defaults to 1
-    :type multiplier: int, optional
-    :return: [description]
-    :rtype: [type]
-    """
     try:
         value = int(value) * multiplier
         return value

setup.py

@@ -3,19 +3,22 @@
 with open("README.md", "r") as readme:
     long_description = readme.read()
 
-with open('requirements.txt') as req_file:
-    requirements = req_file.read().splitlines()
+# with open('requirements.txt') as req_file:
+#     requirements = req_file.read().splitlines()
 
 setuptools.setup(
     name="pyimgbatch",
     author="Sören Kirchner",
     author_email="[email protected]",
-    description="A small example package",
+    description="PyImgBatch is a batch image processor for python including a command line interface.",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/soeren-kirchner/pyimgbatch",
     # packages=['pyimgbatch'],
-    install_requires=requirements,
+    install_requires=[
+        "Pillow>=6.2.1",
+        "tqdm>=4.36.1"
+    ],
     packages=setuptools.find_packages(),
     classifiers=[
         "Programming Language :: Python :: 3.6",
@@ -34,7 +37,7 @@
         "Topic :: Utilities"
     ],
     python_requires='>=3.6',
-    version="0.2.5",
+    version="0.2.6post2",
     # version_config={
     #     "version_format": "{tag}.dev{sha}",
     #     "starting_version": "0.1.0"