"""Setup for lti_consumer XBlock.""" import os import re from setuptools import find_packages, setup def package_data(pkg, roots): """Generic function to find package_data. All of the files under each of the `roots` will be declared as package data for package `pkg`. """ data = [] for root in roots: for dirname, __, files in os.walk(os.path.join(pkg, root)): for fname in files: data.append(os.path.relpath(os.path.join(dirname, fname), pkg)) return {pkg: data} def load_requirements(*requirements_paths): """ Load all requirements from the specified requirements files. Requirements will include any constraints from files specified with -c in the requirements files. Returns a list of requirement strings. """ # UPDATED VIA SEMGREP - if you need to remove/modify this method remove this line and add a comment specifying why. requirements = {} constraint_files = set() # groups "my-package-name<=x.y.z,..." into ("my-package-name", "<=x.y.z,...") requirement_line_regex = re.compile(r"([a-zA-Z0-9-_.]+)([<>=][^#\s]+)?") def add_version_constraint_or_raise(current_line, current_requirements, add_if_not_present): regex_match = requirement_line_regex.match(current_line) if regex_match: package = regex_match.group(1) version_constraints = regex_match.group(2) existing_version_constraints = current_requirements.get(package, None) # it's fine to add constraints to an unconstrained package, but raise an error if there are already # constraints in place if existing_version_constraints and existing_version_constraints != version_constraints: raise BaseException(f'Multiple constraint definitions found for {package}:' f' "{existing_version_constraints}" and "{version_constraints}".' f'Combine constraints into one location with {package}' f'{existing_version_constraints},{version_constraints}.') if add_if_not_present or package in current_requirements: current_requirements[package] = version_constraints # process .in files and store the path to any constraint files that are pulled in for path in requirements_paths: with open(path) as reqs: for line in reqs: if is_requirement(line): add_version_constraint_or_raise(line, requirements, True) if line and line.startswith('-c') and not line.startswith('-c http'): constraint_files.add(os.path.dirname(path) + '/' + line.split('#')[0].replace('-c', '').strip()) # process constraint files and add any new constraints found to existing requirements for constraint_file in constraint_files: with open(constraint_file) as reader: for line in reader: if is_requirement(line): add_version_constraint_or_raise(line, requirements, False) # process back into list of pkg><=constraints strings constrained_requirements = [f'{pkg}{version or ""}' for (pkg, version) in sorted(requirements.items())] return constrained_requirements def is_requirement(line): """ Return True if the requirement line is a package requirement. Returns: bool: True if the line is not blank, a comment, a URL, or an included file """ # UPDATED VIA SEMGREP - if you need to remove/modify this method remove this line and add a comment specifying why return line and line.strip() and not line.startswith(('-r', '#', '-e', 'git+', '-c')) with open('README.rst') as _f: long_description = _f.read() def get_version(file_path): """ Extract the version string from the file at the given relative path fragments. """ filename = os.path.join(os.path.dirname(__file__), file_path) with open(filename, encoding='utf-8') as opened_file: version_file = opened_file.read() version_match = re.search(r"(?m)^__version__ = ['\"]([^'\"]+)['\"]", version_file) if version_match: return version_match.group(1) raise RuntimeError('Unable to find version string.') VERSION = get_version("lti_consumer/__init__.py") setup( name='lti-consumer-xblock', version=VERSION, author='Open edX project', author_email='oscm@edx.org', description='This XBlock implements the consumer side of the LTI specification.', long_description=long_description, long_description_content_type='text/x-rst', packages=find_packages(), install_requires=load_requirements('requirements/base.in'), dependency_links=[ 'https://github.com/openedx/xblock-utils/tarball/c39bf653e4f27fb3798662ef64cde99f57603f79#egg=xblock-utils', ], entry_points={ 'xblock.v1': [ 'lti_consumer = lti_consumer.lti_xblock:LtiConsumerXBlock', ], 'lms.djangoapp': [ "lti_consumer = lti_consumer.apps:LTIConsumerApp", ], 'cms.djangoapp': [ "lti_consumer = lti_consumer.apps:LTIConsumerApp", ] }, package_data=package_data("lti_consumer", ["static", "templates", "public", "translations"]), keywords='lti consumer xblock', url='https://github.com/openedx/xblock-lti-consumer', classifiers=[ 'Development Status :: 5 - Production/Stable', 'Framework :: Django', 'Framework :: Django :: 3.2', 'Framework :: Django :: 4.0', 'Intended Audience :: Developers', 'License :: OSI Approved :: GNU Affero General Public License v3', 'Natural Language :: English', "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.8", ] )