Feature/package

.gitignore

@@ -1,2 +1,3 @@
 *~
-examples/out.png
+examples/out.png
+lbpcascade_animeface.py

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 nagadomi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1,10 @@
+# Include the README
+include *.md
+include lbpcascade_animeface/*.py 
+include lbpcascade_animeface/lbpcascade_animeface.xml
+
+# Include the license file
+# include LICENSE.txt
+
+# Include the data files
+# recursive-include data *

README.md

@@ -4,6 +4,11 @@ The face detector for anime/manga using OpenCV.
 
 Original release since 2011 at [OpenCVによるアニメ顔検出ならlbpcascade_animeface.xml](http://ultraist.hatenablog.com/entry/20110718/1310965532) (in Japanese)
 
+## Installation
+
+Run `pip install setup.py` to install it from `setup.py` file 
+or `pip install lbpcascade-animeface` to install from pypi
+
 ## Usage
 
 Download and place the cascade file into your project directory.
@@ -47,6 +52,8 @@ detect(sys.argv[1])
 Run
 
     python detect.py imas.jpg
+    # or if it is installed through setup.py or pypi
+    lbpcascade-animeface imas.jpg
 
 ![result](https://user-images.githubusercontent.com/287255/43184241-ed3f1af8-9022-11e8-8800-468b002c73d9.png)
 

examples/detect.py

@@ -1,8 +1,31 @@
-import cv2
-import sys
+#!/usr/bin/env python
 import os.path
+import pkg_resources
+import sys
+
+import click
+import cv2
+
 
-def detect(filename, cascade_file = "../lbpcascade_animeface.xml"):
+XML_PATH = pkg_resources.resource_filename('lbpcascade_animeface', "lbpcascade_animeface.xml")
+
+
+@click.command()
+@click.argument('filename')
+@click.option(
+    '--cascade-file', default="lbpcascade_animeface.xml", help='Cascade file.')
+@click.option('--write/--no-write', default=True, help='Write output to file')
+@click.option('--dst-file', default='out.png', help='File destination.')
+@click.option('--show/--no-show', default=True, help='Show result.')
+def cli(
+        filename, cascade_file="lbpcascade_animeface.xml",
+        write=True, dst_file='out.png', show=True):
+    detect(filename, cascade_file, write, dst_file, show)
+
+
+def detect(
+        filename, cascade_file="lbpcascade_animeface.xml",
+        write=True, dst_file='out.png', show=True):
     if not os.path.isfile(cascade_file):
         raise RuntimeError("%s: not found" % cascade_file)
 
@@ -19,12 +42,17 @@ def detect(filename, cascade_file = "../lbpcascade_animeface.xml"):
     for (x, y, w, h) in faces:
         cv2.rectangle(image, (x, y), (x + w, y + h), (0, 0, 255), 2)
 
-    cv2.imshow("AnimeFaceDetect", image)
-    cv2.waitKey(0)
-    cv2.imwrite("out.png", image)
+    if show:
+        cv2.imshow("AnimeFaceDetect", image)
+        cv2.waitKey(0)
+    if write:
+        cv2.imwrite(dst_file, image)
+    return {
+        'faces': faces,
+        'cascade': cascade,
+        'image': image,
+    }
 
-if len(sys.argv) != 2:
-    sys.stderr.write("usage: detect.py <filename>\n")
-    sys.exit(-1)
-
-detect(sys.argv[1])
+
+if __name__ == '__main__':
+    cli()

lbpcascade_animeface/__init__.py

@@ -0,0 +1 @@
+from .__main__ import detect, XML_PATH

requirements.txt

@@ -0,0 +1 @@
+.

setup.py

@@ -0,0 +1,204 @@
+"""A setuptools for lbpcascade_animeface.
+
+this setup module is taken and modified from
+https://github.com/pypa/sampleproject/blob/master/setup.py
+"""
+
+import shutil
+# Always prefer setuptools over distutils
+from setuptools import setup, find_packages
+from os import path
+# io.open is needed for projects that support Python 2.7
+# It ensures open() defaults to text mode with universal newlines,
+# and accepts an argument to specify the text encoding
+# Python 3 only projects can skip this import
+from io import open
+
+here = path.abspath(path.dirname(__file__))
+
+# Get the long description from the README file
+with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+
+# copy the detect.py file to root
+if path.isfile('examples/detect.py'):
+    shutil.copyfile('examples/detect.py', 'lbpcascade_animeface/__main__.py')
+    shutil.copyfile('lbpcascade_animeface.xml', 'lbpcascade_animeface/lbpcascade_animeface.xml')
+
+# Arguments marked as "Required" below must be included for upload to PyPI.
+# Fields marked as "Optional" may be commented out.
+
+setup(
+    # This is the name of your project. The first time you publish this
+    # package, this name will be registered for you. It will determine how
+    # users can install this project, e.g.:
+    #
+    # $ pip install sampleproject
+    #
+    # And where it will live on PyPI: https://pypi.org/project/sampleproject/
+    #
+    # There are some restrictions on what makes a valid project name
+    # specification here:
+    # https://packaging.python.org/specifications/core-metadata/#name
+    name='lbpcascade-animeface',  # Required
+
+    # Versions should comply with PEP 440:
+    # https://www.python.org/dev/peps/pep-0440/
+    #
+    # For a discussion on single-sourcing the version across setup.py and the
+    # project code, see
+    # https://packaging.python.org/en/latest/single_source_version.html
+    version='0.1.0',  # Required
+
+    # This is a one-line description or tagline of what your project does. This
+    # corresponds to the "Summary" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#summary
+    description='A Face detector for anime/manga using OpenCV',  # Optional
+
+    # This is an optional longer description of your project that represents
+    # the body of text which users will see when they visit PyPI.
+    #
+    # Often, this is the same as your README, so you can just read it in from
+    # that file directly (as we have already done above)
+    #
+    # This field corresponds to the "Description" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#description-optional
+    long_description=long_description,  # Optional
+
+    # Denotes that our long_description is in Markdown; valid values are
+    # text/plain, text/x-rst, and text/markdown
+    #
+    # Optional if long_description is written in reStructuredText (rst) but
+    # required for plain-text or Markdown; if unspecified, "applications should
+    # attempt to render [the long_description] as text/x-rst; charset=UTF-8 and
+    # fall back to text/plain if it is not valid rst" (see link below)
+    #
+    # This field corresponds to the "Description-Content-Type" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
+    long_description_content_type='text/markdown',  # Optional (see note above)
+
+    # This should be a valid link to your project's main homepage.
+    #
+    # This field corresponds to the "Home-Page" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#home-page-optional
+    url='https://github.com/nagadomi/lbpcascade_animeface',  # Optional
+
+    # This should be your name or the name of the organization which owns the
+    # project.
+    author='nagadomi',  # Optional
+
+    # This should be a valid email address corresponding to the author listed
+    # above.
+    author_email='nagadomi@gmail.com',  # Optional
+
+    # Classifiers help users find your project by categorizing it.
+    #
+    # For a list of valid classifiers, see https://pypi.org/classifiers/
+    classifiers=[  # Optional
+        # How mature is this project? Common values are
+        #   3 - Alpha
+        #   4 - Beta
+        #   5 - Production/Stable
+        'Development Status :: 3 - Alpha',
+
+        # Indicate who your project is intended for
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Build Tools',
+
+        # Pick your license as you wish
+        'License :: OSI Approved :: MIT License',
+
+        # Specify the Python versions you support here. In particular, ensure
+        # that you indicate whether you support Python 2, Python 3 or both.
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+    ],
+
+    # This field adds keywords for your project which will appear on the
+    # project page. What does your project relate to?
+    #
+    # Note that this is a string of words separated by whitespace, not a list.
+    keywords='anime face detector opencv',  # Optional
+
+    # You can just specify package directories manually here if your project is
+    # simple. Or you can use find_packages().
+    #
+    # Alternatively, if you just want to distribute a single Python file, use
+    # the `py_modules` argument instead as follows, which will expect a file
+    # called `my_module.py` to exist:
+    #
+    #   py_modules=["my_module"],
+    #
+    packages=find_packages(exclude=['contrib', 'docs', 'tests']),  # Required
+
+    # This field lists other packages that your project depends on to run.
+    # Any package you put here will be installed by pip when your project is
+    # installed, so they must be valid existing projects.
+    #
+    # For an analysis of "install_requires" vs pip's requirements files see:
+    # https://packaging.python.org/en/latest/requirements.html
+    install_requires=['opencv-python>=3.4.3.18', 'Click>=7.0'],  # Optional
+
+    # List additional groups of dependencies here (e.g. development
+    # dependencies). Users will be able to install these using the "extras"
+    # syntax, for example:
+    #
+    #   $ pip install sampleproject[dev]
+    #
+    # Similar to `install_requires` above, these must be valid existing
+    # projects.
+    extras_require={  # Optional
+        'dev': ['check-manifest'],
+        'test': ['coverage'],
+    },
+
+    # If there are data files included in your packages that need to be
+    # installed, specify them here.
+    #
+    # If using Python 2.6 or earlier, then these have to be included in
+    # MANIFEST.in as well.
+    package_data={  # Optional
+        'lbpcascade_animeface': ['lbpcascade_animeface.xml'],
+    },
+
+    # Although 'package_data' is the preferred approach, in some case you may
+    # need to place data files outside of your packages. See:
+    # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files
+    #
+    # In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
+    #  data_files=[('my_data', ['data/data_file'])],  # Optional
+    #  data_files=[('lbpcascade_animeface.xml', ['data/lbpcascade_animeface.xml'])],  # Optional
+
+    # To provide executable scripts, use entry points in preference to the
+    # "scripts" keyword. Entry points provide cross-platform support and allow
+    # `pip` to create the appropriate form of executable for the target
+    # platform.
+    #
+    # For example, the following would provide a command called `sample` which
+    # executes the function `main` from this package when invoked:
+    entry_points={  # Optional
+        'console_scripts': [
+            'lbpcascade-animeface=lbpcascade_animeface.__main__:cli',
+        ],
+    },
+
+    # List additional URLs that are relevant to your project as a dict.
+    #
+    # This field corresponds to the "Project-URL" metadata fields:
+    # https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
+    #
+    # Examples listed include a pattern for specifying where the package tracks
+    # issues, where the source is hosted, where to say thanks to the package
+    # maintainers, and where to support the project financially. The key is
+    # what's used to render the link text on PyPI.
+    project_urls={  # Optional
+        'Bug Reports': 'https://github.com/nagadomi/lbpcascade_animeface/issues',
+        #  'Funding': 'https://donate.pypi.org',
+        #  'Say Thanks!': 'http://saythanks.io/to/example',
+        'Source': 'https://github.com/nagadomi/lbpcascade_animeface',
+    },
+)