setuptools.command.easy_install.easy_install Class Reference

Inheritance diagram for setuptools.command.easy_install.easy_install:

Public Member Functions
def	initialize_options
def	delete_blockers
def	finalize_options
def	expand_basedirs
def	expand_dirs
def	run
def	pseudo_tempname
def	warn_deprecated_options
def	check_site_dir
def	cant_write_to_target
def	check_pth_processing
def	install_egg_scripts
def	add_output
def	not_editable
def	check_editable
def	easy_install
def	install_item
def	select_scheme
def	process_distribution
def	should_unzip
def	maybe_move
def	install_wrapper_scripts
def	install_script
def	write_script
def	install_eggs
def	egg_distribution
def	install_egg
def	install_exe
def	exe_to_egg
def	installation_report
def	report_editable
def	run_setup
def	build_and_install
def	update_pth
def	unpack_progress
def	unpack_and_compile
def	byte_compile
def	no_default_version_msg
def	install_site_py
def	create_home_path
Public Member Functions inherited from setuptools.Command
def	__init__
def	reinitialize_command

Public Attributes
	user
	zip_ok
	local_snapshots_ok
	install_dir
	script_dir
	exclude_scripts
	index_url
	find_links
	build_directory
	args
	optimize
	record
	upgrade
	always_copy
	multi_version
	editable
	no_deps
	allow_hosts
	root
	prefix
	no_report
	version
	install_purelib
	install_platlib
	install_headers
	install_lib
	install_scripts
	install_data
	install_base
	install_platbase
	install_userbase
	install_usersite
	no_find_links
	package_index
	pth_file
	always_copy_from
	site_dirs
	installed_projects
	sitepy_installed
	verbose
	config_vars
	all_site_dirs
	shadow_path
	local_index
	outputs

Static Public Attributes
string	description = "Find/get/install Python packages"
	command_consumes_arguments = True
list	user_options
list	boolean_options
string	help_msg = "install in user site-package '%s'"
dictionary	negative_opt = {'always-unzip': 'zip-ok'}
	create_index = PackageIndex
tuple	INSTALL_SCHEMES
tuple	DEFAULT_SCHEME
Static Public Attributes inherited from setuptools.Command
	command_consumes_arguments = False

Private Member Functions
def	_expand_attrs
def	_set_fetcher_options
def	_expand

Private Attributes
	_dry_run

Detailed Description

Manage a download/build/install process

Constructor & Destructor Documentation

def setuptools.command.easy_install.easy_install.easy_install	(		self,
			spec,
			deps = False
	)

Member Function Documentation

def setuptools.command.easy_install.easy_install._expand (   self,   attrs  )

private

def setuptools.command.easy_install.easy_install._expand_attrs (   self,   attrs  )

private

def setuptools.command.easy_install.easy_install._set_fetcher_options (   self,   base  )

private

When easy_install is about to run bdist_egg on a source dist, that
source dist might have 'setup_requires' directives, requiring
additional fetching. Ensure the fetcher options given to easy_install
are available to that command as well.

def setuptools.command.easy_install.easy_install.add_output	(		self,
			path
	)

def setuptools.command.easy_install.easy_install.build_and_install	(		self,
			setup_script,
			setup_base
	)

def setuptools.command.easy_install.easy_install.byte_compile	(		self,
			to_compile
	)

def setuptools.command.easy_install.easy_install.cant_write_to_target

(

self

)

def setuptools.command.easy_install.easy_install.check_editable	(		self,
			spec
	)

def setuptools.command.easy_install.easy_install.check_pth_processing

(

self

)

Empirically verify whether .pth files are supported in inst. dir

def setuptools.command.easy_install.easy_install.check_site_dir

(

self

)

Verify that self.install_dir is .pth-capable dir, if needed

def setuptools.command.easy_install.easy_install.create_home_path

(

self

)

Create directories under ~.

def setuptools.command.easy_install.easy_install.delete_blockers	(		self,
			blockers
	)

def setuptools.command.easy_install.easy_install.egg_distribution	(		self,
			egg_path
	)

def setuptools.command.easy_install.easy_install.exe_to_egg	(		self,
			dist_filename,
			egg_tmp
	)

Extract a bdist_wininst to the directories an egg would use

def setuptools.command.easy_install.easy_install.expand_basedirs

(

self

)

Calls `os.path.expanduser` on install_base, install_platbase and
root.

def setuptools.command.easy_install.easy_install.expand_dirs

(

self

)

Calls `os.path.expanduser` on install dirs.

def setuptools.command.easy_install.easy_install.finalize_options

(

self

)

def setuptools.command.easy_install.easy_install.initialize_options

(

self

)

def setuptools.command.easy_install.easy_install.install_egg	(		self,
			egg_path,
			tmpdir
	)

def setuptools.command.easy_install.easy_install.install_egg_scripts	(		self,
			dist
	)

Write all the scripts for `dist`, unless scripts are excluded

def setuptools.command.easy_install.easy_install.install_eggs	(		self,
			spec,
			dist_filename,
			tmpdir
	)

def setuptools.command.easy_install.easy_install.install_exe	(		self,
			dist_filename,
			tmpdir
	)

def setuptools.command.easy_install.easy_install.install_item	(		self,
			spec,
			download,
			tmpdir,
			deps,
			install_needed = False
	)

def setuptools.command.easy_install.easy_install.install_script	(		self,
			dist,
			script_name,
			script_text,
			dev_path = None
	)

Generate a legacy script wrapper and install it

def setuptools.command.easy_install.easy_install.install_site_py

(

self

)

Make sure there's a site.py in the target dir, if needed

def setuptools.command.easy_install.easy_install.install_wrapper_scripts	(		self,
			dist
	)

def setuptools.command.easy_install.easy_install.installation_report	(		self,
			req,
			dist,
			what = "Installed"
	)

Helpful installation message for display to package users

def setuptools.command.easy_install.easy_install.maybe_move	(		self,
			spec,
			dist_filename,
			setup_base
	)

def setuptools.command.easy_install.easy_install.no_default_version_msg

(

self

)

def setuptools.command.easy_install.easy_install.not_editable	(		self,
			spec
	)

def setuptools.command.easy_install.easy_install.process_distribution	(		self,
			requirement,
			dist,
			deps = True,
			info
	)

def setuptools.command.easy_install.easy_install.pseudo_tempname

(

self

)

Return a pseudo-tempname base in the install directory.
This code is intentionally naive; if a malicious party can write to
the target directory you're already in deep doodoo.

def setuptools.command.easy_install.easy_install.report_editable	(		self,
			spec,
			setup_script
	)

def setuptools.command.easy_install.easy_install.run

(

self

)

def setuptools.command.easy_install.easy_install.run_setup	(		self,
			setup_script,
			setup_base,
			args
	)

def setuptools.command.easy_install.easy_install.select_scheme	(		self,
			name
	)

Sets the install directories by applying the install schemes.

def setuptools.command.easy_install.easy_install.should_unzip	(		self,
			dist
	)

def setuptools.command.easy_install.easy_install.unpack_and_compile	(		self,
			egg_path,
			destination
	)

def setuptools.command.easy_install.easy_install.unpack_progress	(		self,
			src,
			dst
	)

def setuptools.command.easy_install.easy_install.update_pth	(		self,
			dist
	)

def setuptools.command.easy_install.easy_install.warn_deprecated_options

(

self

)

def setuptools.command.easy_install.easy_install.write_script	(		self,
			script_name,
			contents,
			mode = "t",
			blockers = ()
	)

Write an executable file to the scripts directory

Member Data Documentation

setuptools.command.easy_install.easy_install._dry_run

private

setuptools.command.easy_install.easy_install.all_site_dirs

setuptools.command.easy_install.easy_install.allow_hosts

setuptools.command.easy_install.easy_install.always_copy

setuptools.command.easy_install.easy_install.always_copy_from

setuptools.command.easy_install.easy_install.args

list setuptools.command.easy_install.easy_install.boolean_options

static

Initial value:

= [
        'zip-ok', 'multi-version', 'exclude-scripts', 'upgrade', 'always-copy',
        'editable',
        'no-deps', 'local-snapshots-ok', 'version'
    ]

setuptools.command.easy_install.easy_install.build_directory

setuptools.command.easy_install.easy_install.command_consumes_arguments = True

static

setuptools.command.easy_install.easy_install.config_vars

setuptools.command.easy_install.easy_install.create_index = PackageIndex

static

tuple setuptools.command.easy_install.easy_install.DEFAULT_SCHEME

static

Initial value:

= dict(
        install_dir = '$base/Lib/site-packages',
        script_dir = '$base/Scripts',
    )

string setuptools.command.easy_install.easy_install.description = "Find/get/install Python packages"

static

setuptools.command.easy_install.easy_install.editable

setuptools.command.easy_install.easy_install.exclude_scripts

setuptools.command.easy_install.easy_install.find_links

string setuptools.command.easy_install.easy_install.help_msg = "install in user site-package '%s'"

static

setuptools.command.easy_install.easy_install.index_url

setuptools.command.easy_install.easy_install.install_base

setuptools.command.easy_install.easy_install.install_data

setuptools.command.easy_install.easy_install.install_dir

setuptools.command.easy_install.easy_install.install_headers

setuptools.command.easy_install.easy_install.install_lib

setuptools.command.easy_install.easy_install.install_platbase

setuptools.command.easy_install.easy_install.install_platlib

setuptools.command.easy_install.easy_install.install_purelib

tuple setuptools.command.easy_install.easy_install.INSTALL_SCHEMES

static

Initial value:

= dict(
        posix = dict(
            install_dir = '$base/lib/python$py_version_short/site-packages',
            script_dir = '$base/bin',
        ),
    )

setuptools.command.easy_install.easy_install.install_scripts

setuptools.command.easy_install.easy_install.install_userbase

setuptools.command.easy_install.easy_install.install_usersite

setuptools.command.easy_install.easy_install.installed_projects

setuptools.command.easy_install.easy_install.local_index

setuptools.command.easy_install.easy_install.local_snapshots_ok

setuptools.command.easy_install.easy_install.multi_version

dictionary setuptools.command.easy_install.easy_install.negative_opt = {'always-unzip': 'zip-ok'}

static

setuptools.command.easy_install.easy_install.no_deps

setuptools.command.easy_install.easy_install.no_find_links

setuptools.command.easy_install.easy_install.no_report

setuptools.command.easy_install.easy_install.optimize

setuptools.command.easy_install.easy_install.outputs

setuptools.command.easy_install.easy_install.package_index

setuptools.command.easy_install.easy_install.prefix

setuptools.command.easy_install.easy_install.pth_file

setuptools.command.easy_install.easy_install.record

setuptools.command.easy_install.easy_install.root

setuptools.command.easy_install.easy_install.script_dir

setuptools.command.easy_install.easy_install.shadow_path

setuptools.command.easy_install.easy_install.site_dirs

setuptools.command.easy_install.easy_install.sitepy_installed

setuptools.command.easy_install.easy_install.upgrade

setuptools.command.easy_install.easy_install.user

list setuptools.command.easy_install.easy_install.user_options

static

Initial value:

= [
        ('prefix=', None, "installation prefix"),
        ("zip-ok", "z", "install package as a zipfile"),
        ("multi-version", "m", "make apps have to require() a version"),
        ("upgrade", "U", "force upgrade (searches PyPI for latest versions)"),
        ("install-dir=", "d", "install package to DIR"),
        ("script-dir=", "s", "install scripts to DIR"),
        ("exclude-scripts", "x", "Don't install scripts"),
        ("always-copy", "a", "Copy all needed packages to install dir"),
        ("index-url=", "i", "base URL of Python Package Index"),
        ("find-links=", "f", "additional URL(s) to search for packages"),
        ("build-directory=", "b",
            "download/extract/build in DIR; keep the results"),
        ('optimize=', 'O',
            "also compile with optimization: -O1 for \"python -O\", "
            "-O2 for \"python -OO\", and -O0 to disable [default: -O0]"),
        ('record=', None,
            "filename in which to record list of installed files"),
        ('always-unzip', 'Z', "don't install as a zipfile, no matter what"),
        ('site-dirs=','S',"list of directories where .pth files work"),
        ('editable', 'e', "Install specified packages in editable form"),
        ('no-deps', 'N', "don't install dependencies"),
        ('allow-hosts=', 'H', "pattern(s) that hostnames must match"),
        ('local-snapshots-ok', 'l',
            "allow building eggs from local checkouts"),
        ('version', None, "print version information and exit"),
        ('no-find-links', None,
            "Don't load find-links defined in packages being installed")
    ]

setuptools.command.easy_install.easy_install.verbose

setuptools.command.easy_install.easy_install.version

setuptools.command.easy_install.easy_install.zip_ok

---

The documentation for this class was generated from the following file:

• orbits/lib/python2.7/site-packages/setuptools/command/easy_install.py