setup.py

"""A setuptools based setup module.
See:
https://packaging.python.org/en/latest/distributing.html
https://github.com/pypa/sampleproject

Building a new version:
1. bump version number in VERSION
2.
python3 setup.py sdist bdist_wheel

3.
python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*

"""

from os import path, walk, getcwd

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

manually_excluded = ['plugins.PCBPlugin3', 'plugins.PCBPlugin4', 'TreesAreMemory3']


def plugin_files(directory):
    paths = []
    for (fpath, directories, filenames) in walk(directory):
        if fpath.replace('/', '.') in manually_excluded or fpath in symlinked_plugins:
            break
        elif fpath.strip().endswith('__pycache__'):
            break
        elif fpath.strip().endswith('versions'):
            break

        for dir in directories:
            dir_path = path.join(fpath, dir)
            if dir.startswith('.') or path.islink(dir_path):
                continue
            paths += plugin_files(dir_path)
        for filename in filenames:
            if filename.startswith('.') or filename.endswith('.pyc') or filename.endswith('.py'):
                continue
            paths.append(path.join(fpath, filename)[7:])
    return paths


def find_symlinks(directory):
    paths = []
    for (fpath, directories, filenames) in walk(directory, followlinks=True):
        for dir in directories:
            dir_path = path.join(fpath, dir)
            if path.islink(dir_path):
                paths.append(dir_path)
            else:
                paths += find_symlinks(dir_path)
        for filename in filenames:
            f_path = path.join(fpath, filename)
            if path.islink(f_path):
                paths.append(f_path)
    return [x.replace('/', '.') for x in paths]

here = path.abspath(getcwd())
#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()

with open(path.join(here, 'VERSION')) as version_file:
    version = version_file.read().rsplit('|', 1)[-1].strip()

# at the moment we want to EXCLUDE symlinked plugins, as these are unpublished attempts
symlinked_plugins = find_symlinks('kataja/plugins')

plugin_data_files = plugin_files('kataja/plugins')

# 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='kataja',  # 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=version,  # 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='Visualising minimalist grammars',  # 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/jpurma/kataja',  # Optional

    # This should be your name or the name of the organization which owns the
    # project.
    author='Jukka Purma',  # Optional

    # This should be a valid email address corresponding to the author listed
    # above.
    author_email='jukka.purma@aalto.fi',  # 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 :: Science/Research',
        'Topic :: Scientific/Engineering :: Visualization',
        'Topic :: Text Processing :: Linguistic',

        # Pick your license as you wish
        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',

        # 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.9'
    ],

    # 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='syntax tree visualization grammar minimalism biolinguistics',  # 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', 'venv', '.git'] + symlinked_plugins + manually_excluded),  # 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=['PyQt6>=6.1.1', 'Pillow>=8.3.1'],  # 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
    #     'sample': ['package_data.dat'],
    # },
    package_data={
        'kataja': ['resources/*', 'resources/*/*'] + plugin_data_files
    },

    # 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

    # 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': [
            'kataja=kataja:__main__',
        ],
    },

    # 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
        'Kataja site': 'https://purma.fi/kataja'
    },
)

print('excluded plugins: ', symlinked_plugins + manually_excluded)