papermill

1
#!/usr/bin/env python
2
""""
3
setup.py
4

5
See:
6
https://packaging.python.org/tutorials/packaging-projects/
7
https://packaging.python.org/en/latest/distributing.html
8
https://github.com/pypa/sampleproject
9

10
"""
11
import os
12

13
from setuptools import setup
14

15
local_path = os.path.dirname(__file__)
16
# Fix for tox which manipulates execution pathing
17
if not local_path:
18
    local_path = '.'
19
here = os.path.abspath(local_path)
20

21

22
def version():
23
    with open(f"{here}/papermill/version.py") as ver:
24
        for line in ver.readlines():
25
            if line.startswith('version ='):
26
                return line.split(' = ')[-1].strip()[1:-1]
27
    raise ValueError('No version found in papermill/version.py')
28

29

30
def read(fname):
31
    with open(fname) as fhandle:
32
        return fhandle.read()
33

34

35
def read_reqs(fname, folder=None):
36
    path_dir = os.path.join(here, folder) if folder else here
37
    req_path = os.path.join(path_dir, fname)
38
    return [req.strip() for req in read(req_path).splitlines() if req.strip()]
39

40

41
s3_reqs = read_reqs('s3.txt', folder='requirements')
42
azure_reqs = read_reqs('azure.txt', folder='requirements')
43
gcs_reqs = read_reqs('gcs.txt', folder='requirements')
44
hdfs_reqs = read_reqs('hdfs.txt', folder='requirements')
45
github_reqs = read_reqs('github.txt', folder='requirements')
46
docs_only_reqs = read_reqs('docs.txt', folder='requirements')
47
black_reqs = ['black >= 19.3b0']
48
all_reqs = s3_reqs + azure_reqs + gcs_reqs + hdfs_reqs + github_reqs + black_reqs
49
docs_reqs = all_reqs + docs_only_reqs
50
# Temporarily remove hdfs_reqs from dev deps until the pyarrow package is available for Python 3.12
51
dev_reqs = read_reqs('dev.txt', folder='requirements') + s3_reqs + azure_reqs + gcs_reqs + black_reqs  # all_reqs
52
extras_require = {
53
    "test": dev_reqs,
54
    "dev": dev_reqs,
55
    "all": all_reqs,
56
    "s3": s3_reqs,
57
    "azure": azure_reqs,
58
    "gcs": gcs_reqs,
59
    "hdfs": hdfs_reqs,
60
    "github": github_reqs,
61
    "black": black_reqs,
62
    "docs": docs_reqs,
63
}
64

65
# Get the long description from the README file
66
with open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
67
    long_description = f.read()
68

69
setup(
70
    name='papermill',
71
    version=version(),
72
    description='Parameterize and run Jupyter and nteract Notebooks',
73
    author='nteract contributors',
74
    author_email='nteract@googlegroups.com',
75
    license='BSD',
76
    # Note that this is a string of words separated by whitespace, not a list.
77
    keywords='jupyter mapreduce nteract pipeline notebook',
78
    long_description=long_description,
79
    long_description_content_type='text/markdown',
80
    url='https://github.com/nteract/papermill',
81
    packages=['papermill'],
82
    python_requires='>=3.8',
83
    install_requires=read_reqs('requirements.txt'),
84
    extras_require=extras_require,
85
    entry_points={'console_scripts': ['papermill = papermill.__main__:papermill']},
86
    project_urls={
87
        'Documentation': 'https://papermill.readthedocs.io',
88
        'Funding': 'https://nteract.io',
89
        'Source': 'https://github.com/nteract/papermill/',
90
        'Tracker': 'https://github.com/nteract/papermill/issues',
91
    },
92
    classifiers=[
93
        'Intended Audience :: Developers',
94
        'Intended Audience :: System Administrators',
95
        'Intended Audience :: Science/Research',
96
        'License :: OSI Approved :: BSD License',
97
        'Programming Language :: Python',
98
        'Programming Language :: Python :: 3',
99
        'Programming Language :: Python :: 3.8',
100
        'Programming Language :: Python :: 3.9',
101
        'Programming Language :: Python :: 3.10',
102
        'Programming Language :: Python :: 3.11',
103
        'Programming Language :: Python :: 3.12',
104
    ],
105
)
106