s3prl/setup.py at master · vectominist/s3prl

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

# Always prefer setuptools over distutils

import os

from pathlib import Path

from setuptools import setup, find_packages

here = Path(__file__).parent.resolve()

# Get the long description from the README file

long_description = (here / "README.md").read_text(encoding="utf-8")

version = (here / "s3prl" / "version.txt").read_text(encoding="utf-8").strip()

requirements = {}

requirement_files = []

for file in os.listdir(here / "requirements"):

lines = [line.strip() for line in (here / "requirements" / file).open().readlines()]

requirements[Path(file).stem] = lines

requirement_files.append(f"requirements/{file}")

requirements["dev"] = requirements["all"] + requirements["dev"]

install_requires = requirements["install"]

extras_require = {k: v for k, v in requirements.items() if k not in ["install"]}

# 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="s3prl", # 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="Self-Supervised Speech Pre-training and Representation Learning Toolkit", # 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/s3prl/s3prl", # Optional

# This should be your name or the name of the organization which owns the

# project.

author="Shu-wen (Leo) Yang, Andy T. Liu and S3PRL Team", # Optional

# This should be a valid email address corresponding to the author listed

# above.

author_email="leo19941227@gmail.com, tingweiandyliu@gmail.com", # Optional

# Classifiers help users find your project by categorizing it.

# For a list of valid classifiers, see https://pypi.org/classifiers/

classifiers=[

# How mature is this project? Common values are

# 3 - Alpha

# 4 - Beta

# 5 - Production/Stable

"Development Status :: 3 - Alpha",

# Pick your license as you wish

"License :: OSI Approved :: Apache Software License",

"Intended Audience :: Science/Research",

"Topic :: Software Development :: Libraries :: Python Modules",

# Specify the Python versions you support here. In particular, ensure

# that you indicate you support Python 3. These classifiers are *not*

# checked by 'pip install'. See instead 'python_requires' below.

"Programming Language :: Python :: 3",

# 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 list of additional keywords, separated

# by commas, to be used to assist searching for the distribution in a

# larger catalog.

keywords="deep learning, speech, self-supervised, representation, pretraining", # Optional

# When your source code is in a subdirectory under the project root, e.g.

# `src/`, it is necessary to specify the `package_dir` argument.

# package_dir={'': 's3prl'}, # Optional

# You can just specify package directories manually here if your project is

# simple. Or you can use find_packages().

license="Apache Software License",

# 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(include=["s3prl*"]), # Required

# Specify which Python versions you support. In contrast to the

# 'Programming Language' classifiers above, 'pip install' will check this

# and refuse to install the project if the version does not match. See

# https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires

python_requires=">=3.6, <4",

# 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=install_requires, # 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=extras_require,

# If there are data files included in your packages that need to be

# installed, specify them here.

package_data={ # Optional

"s3prl": ["version.txt"],

"s3prl.upstream": ["*/*.yaml", "*/*/*.yaml"]

# 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/distutils/setupscript.html#installing-additional-files

# In this case, 'data_file' will be installed into '<sys.prefix>/my_data'

data_files=[("requirements", requirement_files)], # 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": [

"s3prl-main=s3prl.main: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

"Bug Reports": "https://github.com/s3prl/s3prl/issues",

"Source": "https://github.com/s3prl/s3prl/",

)

FilesExpand file tree

setup.py

Latest commit

History

setup.py

File metadata and controls