mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
9249f8639b
Add setuptools' find_packages() to avoid repeated updates to the list of packages. Add setup() arguments, such as classifiers (Trove classifiers used for project classification and searching), keywords, and extra requirements. Add pip requirements installation file. Update supported tuf installation options: Installing from pip and installing an extras requirement (pip install tuf[fast_ed25519]).
107 lines
3 KiB
Python
Executable file
107 lines
3 KiB
Python
Executable file
#! /usr/bin/env python
|
|
|
|
"""
|
|
<Program Name>
|
|
setup.py
|
|
|
|
<Author>
|
|
Vladimir Diaz <vladimir.v.diaz@gmail.com>
|
|
|
|
<Started>
|
|
March 2013.
|
|
|
|
<Copyright>
|
|
See LICENSE for licensing information.
|
|
|
|
<Purpose>
|
|
BUILD SOURCE DISTRIBUTION
|
|
|
|
The following shell command generates a TUF source archive that can be
|
|
distributed to other users. The packaged source is saved to the 'dist'
|
|
folder in the current directory.
|
|
|
|
$ python setup.py sdist
|
|
|
|
|
|
INSTALLATION OPTIONS
|
|
|
|
pip - installing and managing Python packages (recommended):
|
|
|
|
# Installing from Python Package Index (https://pypi.python.org/pypi).
|
|
$ pip install tuf
|
|
|
|
# Installing from local source archive.
|
|
$ pip install <path to archive>
|
|
|
|
# Or from the root directory of the unpacked archive.
|
|
$ pip install .
|
|
|
|
# Installing optional requirements (i.e., after installing tuf).
|
|
# 'fast_ed25519' currently supported, which enables faster and more secure
|
|
# ed25519 key generation and signature verification computations with
|
|
# pynacl+libsodium.
|
|
$ pip install tuf[fast_ed25519]
|
|
|
|
|
|
Alternate installation options:
|
|
|
|
Navigate to the root directory of the unpacked archive and
|
|
run one of the following shell commands:
|
|
|
|
Install to the global site-packages directory.
|
|
$ python setup.py install
|
|
|
|
Install to the user site-packages directory.
|
|
$ python setup.py install --user
|
|
|
|
Install to a chosen directory.
|
|
$ python setup.py install --home=<directory>
|
|
|
|
|
|
Note: The last two installation options may require modification of
|
|
Python's search path (i.e., 'sys.path') or updating an OS environment
|
|
variable. For example, installing to the user site-packages directory might
|
|
result in the installation of TUF scripts to '~/.local/bin'. The user may
|
|
then be required to update his $PATH variable:
|
|
$ export PATH=$PATH:~/.local/bin
|
|
"""
|
|
|
|
from setuptools import setup
|
|
from setuptools import find_packages
|
|
|
|
extras = {
|
|
'fast_ed25519': ['pynacl>=0.2.3']
|
|
}
|
|
|
|
setup(
|
|
name = 'tuf',
|
|
version = '0.7.5',
|
|
description = 'A secure updater framework for Python',
|
|
author = 'http://www.theupdateframework.com',
|
|
author_email = 'theupdateframework@googlegroups.com',
|
|
url = 'http://www.theupdateframework.com',
|
|
keywords = 'update updater secure authentication key compromise revocation',
|
|
classifiers = [
|
|
'Development Status :: 4 - Beta',
|
|
'Intended Audience :: Developers',
|
|
'License :: Freely Distributable',
|
|
'Natural Language :: English',
|
|
'Operating System :: POSIX',
|
|
'Operating System :: POSIX :: Linux',
|
|
'Operating System :: MacOS :: MacOS X',
|
|
'Operating System :: Microsoft :: Windows',
|
|
'Programming Language :: Python',
|
|
'Programming Language :: Python :: 2',
|
|
'Programming Language :: Python :: 2.6',
|
|
'Programming Language :: Python :: 2.7',
|
|
'Programming Language :: Python :: Implementation :: CPython',
|
|
'Topic :: Security',
|
|
'Topic :: Software Development'
|
|
],
|
|
install_requires = ['pycrypto>=2.6.1'],
|
|
packages = find_packages(exclude=['tests', 'tuf.tests']),
|
|
extras_require = extras,
|
|
scripts = [
|
|
'tuf/client/basic_client.py'
|
|
]
|
|
)
|