setup.py

"""ansible-generator allows for users to generate ansible directory structures.

This supports both directory layouts outlined in the Ansible best practices
guide.

See:
https://github.com/kkirsche/ansible-generator
http://docs.ansible.com/ansible/latest/playbooks_best_practices.html#directory-layout
http://docs.ansible.com/ansible/latest/playbooks_best_practices.html#alternative-directory-layout
"""

from os import path

# Always prefer setuptools over distutils
from setuptools import find_packages, setup

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()

setup(
    name="ansible-generator",
    # Versions should comply with PEP440.  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="3.1.1",
    description="Generate ansible directory structures",
    long_description=long_description,
    long_description_content_type="text/markdown",
    # The project's main homepage.
    url="https://github.com/kkirsche/ansible-generator",
    # Downloadable package
    download_url="https://github.com/kkirsche/ansible-generator/archive/v3.0.0.tar.gz",
    # Author details
    author="Kevin Kirsche",
    author_email="kev.kirsche@gmail.com",
    # Choose your license
    license="BSD",
    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
    classifiers=[
        # How mature is this project? Common values are
        #   3 - Alpha
        #   4 - Beta
        #   5 - Production/Stable
        "Development Status :: 5 - Production/Stable",
        # Indicate who your project is intended for
        "Intended Audience :: Developers",
        "Topic :: Software Development :: Build Tools",
        "License :: OSI Approved :: BSD License",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
    ],
    # What does your project relate to?
    keywords="development ansible generator devops",
    # You can just specify the packages manually here if your project is
    # simple. Or you can use find_packages().
    packages=find_packages(exclude=["contrib", "docs", "tests"]),
    # List run-time dependencies here.  These will be installed by pip when
    # your project is installed. For an analysis of "install_requires" vs pip's
    # requirements files see:
    # https://packaging.python.org/en/latest/requirements.html
    install_requires=["sentry-sdk", "ansible"],
    python_requires=">=3.8",
    # List additional groups of dependencies here (e.g. development
    # dependencies). You can install these using the following syntax,
    # for example:
    # $ pip install -e .[dev,test]
    extras_require={
        "dev": [
            "bandit",
            "black[colorama, uvloop]",
            "codespell",
            "example-isort-formatting-plugin",
            "example-isort-sorting-plugin",
            "flake8",
            "flake8-bugbear",
            "flake8-pyi",
            "interrogate",
            "isort[colors]",
            "mypy",
            "pytest",
            "setuptools",
            "types-setuptools",
        ],
    },
    # If there are data files included in your packages that need to be
    # installed, specify them here.  If using Python 2.6 or less, then these
    # have to be included in MANIFEST.in as well.
    package_data={},
    # 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 # noqa
    # In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
    data_files=[],
    # 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.
    entry_points={"console_scripts": ["ansible-generate=ansible_generator:cli"]},
    project_urls={
        "Bug Reports": "https://github.com/kkirsche/ansible-generator/issues",
        "Source": "https://github.com/kkirsche/ansible-generator",
    },
)