PyScaffold
v4.0
Why PyScaffold?
Features
Installation
Examples
Configuration
Dependency Management
Migrating to PyScaffold
Updating
Extending PyScaffold
Embedding PyScaffold
Contributions & Help
FAQ
License
Contributors
Changelog
Module Reference
PyScaffold
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
AbstractContent (in module pyscaffold.structure)
Action (in module pyscaffold.actions)
ActionNotFound
ActionParams (in module pyscaffold.actions)
(in module pyscaffold.structure)
activate() (pyscaffold.extensions.cirrus.Cirrus method)
(pyscaffold.extensions.config.Config method)
(pyscaffold.extensions.Extension method)
(pyscaffold.extensions.gitlab_ci.GitLab method)
(pyscaffold.extensions.namespace.Namespace method)
(pyscaffold.extensions.no_pyproject.NoPyProject method)
(pyscaffold.extensions.no_skeleton.NoSkeleton method)
(pyscaffold.extensions.no_tox.NoTox method)
(pyscaffold.extensions.pre_commit.PreCommit method)
(pyscaffold.extensions.venv.Venv method)
ACTIVITY_MAXLEN (pyscaffold.log.ReportFormatter attribute)
ACTIVITY_STYLES (pyscaffold.log.ColoredReportFormatter attribute)
add() (in module pyscaffold.dependencies)
add_default_args() (in module pyscaffold.cli)
add_dependencies() (in module pyscaffold.update)
add_entrypoints() (in module pyscaffold.update)
add_extension_args() (in module pyscaffold.cli)
add_files() (in module pyscaffold.extensions.cirrus)
(in module pyscaffold.extensions.gitlab_ci)
(in module pyscaffold.extensions.pre_commit)
add_instructions() (in module pyscaffold.extensions.pre_commit)
add_log_related_args() (in module pyscaffold.cli)
add_namespace() (in module pyscaffold.extensions.namespace)
add_permissions() (in module pyscaffold.operations)
add_pyscaffold() (in module pyscaffold.templates)
add_tag() (in module pyscaffold.repo)
all_examples() (in module pyscaffold.extensions.interactive)
alternative_flags() (in module pyscaffold.extensions.interactive)
ALWAYS (in module pyscaffold.update)
augment_cli() (pyscaffold.extensions.cirrus.Cirrus method)
(pyscaffold.extensions.config.Config method)
(pyscaffold.extensions.Extension method)
(pyscaffold.extensions.interactive.Interactive method)
(pyscaffold.extensions.namespace.Namespace method)
(pyscaffold.extensions.venv.Venv method)
author_date (pyscaffold.info.GitEnv attribute)
author_email (pyscaffold.info.GitEnv attribute)
author_name (pyscaffold.info.GitEnv attribute)
B
best_fit_license() (in module pyscaffold.info)
bootstrap_options() (in module pyscaffold.api)
BUILD (in module pyscaffold.dependencies)
C
chdir() (in module pyscaffold.file_system)
check_git() (in module pyscaffold.info)
check_setuptools_version() (in module pyscaffold.dependencies)
chmod() (in module pyscaffold.file_system)
Cirrus (class in pyscaffold.extensions.cirrus)
cirrus_descriptor() (in module pyscaffold.extensions.cirrus)
ColoredReportFormatter (class in pyscaffold.log)
command() (pyscaffold.extensions.interactive.Interactive method)
command_exists() (in module pyscaffold.shell)
comment() (in module pyscaffold.extensions.interactive)
committer_date (pyscaffold.info.GitEnv attribute)
committer_email (pyscaffold.info.GitEnv attribute)
committer_name (pyscaffold.info.GitEnv attribute)
Config (class in pyscaffold.extensions.config)
CONFIG (in module pyscaffold.extensions.interactive)
config_dir() (in module pyscaffold.info)
CONFIG_FILE (in module pyscaffold.info)
config_file() (in module pyscaffold.info)
CONTEXT_PREFIX (pyscaffold.log.ColoredReportFormatter attribute)
(pyscaffold.log.ReportFormatter attribute)
copy() (pyscaffold.log.ReportLogger method)
create() (in module pyscaffold.operations)
create_directory() (in module pyscaffold.file_system)
create_file() (in module pyscaffold.file_system)
create_padding() (pyscaffold.log.ReportFormatter method)
create_project() (in module pyscaffold.api)
create_structure() (in module pyscaffold.structure)
create_with_stdlib() (in module pyscaffold.extensions.venv)
create_with_virtualenv() (in module pyscaffold.extensions.venv)
curses_available() (in module pyscaffold.termui)
D
dasherize() (in module pyscaffold.identification)
decorate() (in module pyscaffold.termui)
deduplicate() (in module pyscaffold.dependencies)
DEFAULT (in module pyscaffold.actions)
(in module pyscaffold.extensions.venv)
DEFAULT_LOGGER (in module pyscaffold.log)
DEFAULT_MESSAGE (pyscaffold.exceptions.GitDirtyWorkspace attribute)
(pyscaffold.exceptions.GitNotConfigured attribute)
(pyscaffold.exceptions.GitNotInstalled attribute)
(pyscaffold.exceptions.NoPyScaffoldProject attribute)
(pyscaffold.exceptions.OldSetuptools attribute)
(pyscaffold.exceptions.PyScaffoldTooOld attribute)
DEFAULT_OPTIONS (in module pyscaffold.api)
define_structure() (in module pyscaffold.structure)
deterministic_name() (in module pyscaffold.identification)
deterministic_sort() (in module pyscaffold.identification)
DirectoryAlreadyExists
DirectoryDoesNotExist
discover() (in module pyscaffold.actions)
dumps() (in module pyscaffold.toml)
E
edit() (in module pyscaffold.shell)
EDITORS (in module pyscaffold.shell)
email() (in module pyscaffold.info)
enforce_namespace_options() (in module pyscaffold.extensions.namespace)
ensure() (in module pyscaffold.structure)
ensure_option() (in module pyscaffold.extensions.no_pyproject)
ERROR_INVALID_NAME (in module pyscaffold.file_system)
ErrorLoadingExtension
example() (in module pyscaffold.extensions.interactive)
example_no_value() (in module pyscaffold.extensions.interactive)
example_with_help() (in module pyscaffold.extensions.interactive)
example_with_value() (in module pyscaffold.extensions.interactive)
exceptions2exit() (in module pyscaffold.exceptions)
expand_computed_opts() (in module pyscaffold.extensions.interactive)
Extension (class in pyscaffold.extensions)
F
FileContents (in module pyscaffold.operations)
FileOp (in module pyscaffold.operations)
find_executable() (in module pyscaffold.extensions.pre_commit)
flag() (pyscaffold.extensions.Extension property)
format() (pyscaffold.log.ReportFormatter method)
format_activity() (pyscaffold.log.ColoredReportFormatter method)
(pyscaffold.log.ReportFormatter method)
format_args() (in module pyscaffold.extensions.interactive)
format_context() (pyscaffold.log.ReportFormatter method)
format_default() (pyscaffold.log.ColoredReportFormatter method)
(pyscaffold.log.ReportFormatter method)
format_path() (pyscaffold.log.ReportFormatter method)
format_report() (pyscaffold.log.ReportFormatter method)
format_subject() (pyscaffold.log.ColoredReportFormatter method)
(pyscaffold.log.ReportFormatter method)
format_target() (pyscaffold.log.ReportFormatter method)
formatter() (pyscaffold.log.ReportLogger property)
G
get_actions() (in module pyscaffold.extensions.interactive)
get_command() (in module pyscaffold.shell)
get_config() (in module pyscaffold.extensions.interactive)
get_curr_version() (in module pyscaffold.info)
get_default_options() (in module pyscaffold.actions)
get_editor() (in module pyscaffold.shell)
get_executable() (in module pyscaffold.shell)
get_git_cmd() (in module pyscaffold.shell)
get_git_root() (in module pyscaffold.repo)
get_id() (in module pyscaffold.identification)
get_log_level() (in module pyscaffold.cli)
get_path() (in module pyscaffold.extensions.venv)
get_template() (in module pyscaffold.templates)
git (in module pyscaffold.shell)
git_tree_add() (in module pyscaffold.repo)
GitDirtyWorkspace
GitEnv (class in pyscaffold.info)
GitLab (class in pyscaffold.extensions.gitlab_ci)
GitNotConfigured
GitNotInstalled
H
handler() (pyscaffold.log.ReportLogger property)
handover_setup_requires() (in module pyscaffold.update)
has_active_extension() (in module pyscaffold.extensions.interactive)
help_text() (pyscaffold.extensions.Extension property)
I
ImpossibleToFindConfigDir
include() (in module pyscaffold.extensions)
indent() (pyscaffold.log.ReportLogger method)
init() (in module pyscaffold.templates)
init_colorama() (in module pyscaffold.termui)
init_commit_repo() (in module pyscaffold.repo)
init_git() (in module pyscaffold.actions)
install() (in module pyscaffold.extensions.pre_commit)
install_packages() (in module pyscaffold.extensions.venv)
instruct_user() (in module pyscaffold.extensions.venv)
Interactive (class in pyscaffold.extensions.interactive)
InvalidIdentifier
invoke() (in module pyscaffold.actions)
is_git_configured() (in module pyscaffold.info)
is_git_installed() (in module pyscaffold.info)
is_git_repo() (in module pyscaffold.repo)
is_git_workspace_clean() (in module pyscaffold.info)
is_pathname_valid() (in module pyscaffold.file_system)
is_valid_identifier() (in module pyscaffold.identification)
isatty() (in module pyscaffold.termui)
ISOLATED (in module pyscaffold.dependencies)
iterate_entry_points() (in module pyscaffold.extensions)
J
join_block() (in module pyscaffold.extensions.interactive)
L
Leaf (in module pyscaffold.structure)
level() (pyscaffold.log.ReportLogger property)
levenshtein() (in module pyscaffold.identification)
license() (in module pyscaffold.templates)
licenses (in module pyscaffold.templates)
list_actions() (in module pyscaffold.cli)
list_from_entry_points() (in module pyscaffold.extensions)
load_from_entry_point() (in module pyscaffold.extensions)
loads() (in module pyscaffold.toml)
localize_path() (in module pyscaffold.file_system)
LOG_STYLES (pyscaffold.log.ColoredReportFormatter attribute)
logger (in module pyscaffold.log)
long_option() (in module pyscaffold.extensions.interactive)
M
main() (in module pyscaffold.cli)
make_valid_identifier() (in module pyscaffold.identification)
merge() (in module pyscaffold.structure)
modify() (in module pyscaffold.structure)
module
pyscaffold
pyscaffold.actions
pyscaffold.api
pyscaffold.cli
pyscaffold.dependencies
pyscaffold.exceptions
pyscaffold.extensions
pyscaffold.extensions.cirrus
pyscaffold.extensions.config
pyscaffold.extensions.gitlab_ci
pyscaffold.extensions.interactive
pyscaffold.extensions.namespace
pyscaffold.extensions.no_pyproject
pyscaffold.extensions.no_skeleton
pyscaffold.extensions.no_tox
pyscaffold.extensions.pre_commit
pyscaffold.extensions.venv
pyscaffold.file_system
pyscaffold.identification
pyscaffold.info
pyscaffold.log
pyscaffold.operations
pyscaffold.repo
pyscaffold.shell
pyscaffold.structure
pyscaffold.templates
pyscaffold.termui
pyscaffold.toml
pyscaffold.update
move() (in module pyscaffold.file_system)
move_old_package() (in module pyscaffold.extensions.namespace)
N
name (pyscaffold.extensions.no_pyproject.NoPyProject attribute)
name() (pyscaffold.extensions.Extension property)
Namespace (class in pyscaffold.extensions.namespace)
nesting (pyscaffold.log.ReportLogger attribute)
NO_CONFIG (in module pyscaffold.api)
no_overwrite() (in module pyscaffold.operations)
Node (in module pyscaffold.structure)
NoPyProject (class in pyscaffold.extensions.no_pyproject)
NoPyScaffoldProject
NoSkeleton (class in pyscaffold.extensions.no_skeleton)
NotInstalled
NoTox (class in pyscaffold.extensions.no_tox)
O
OldSetuptools
on_ro_error() (in module pyscaffold.file_system)
P
parse_args() (in module pyscaffold.cli)
parse_extensions() (in module pyscaffold.templates)
parser (pyscaffold.extensions.interactive.Interactive attribute)
persist (pyscaffold.extensions.config.Config attribute)
(pyscaffold.extensions.Extension attribute)
(pyscaffold.extensions.venv.Venv attribute)
PreCommit (class in pyscaffold.extensions.pre_commit)
prepare_namespace() (in module pyscaffold.extensions.namespace)
process() (pyscaffold.log.ReportLogger method)
project() (in module pyscaffold.info)
propagate() (pyscaffold.log.ReportLogger property)
pyproject_toml() (in module pyscaffold.templates)
pyscaffold
module
pyscaffold.actions
module
pyscaffold.api
module
pyscaffold.cli
module
pyscaffold.dependencies
module
pyscaffold.exceptions
module
pyscaffold.extensions
module
pyscaffold.extensions.cirrus
module
pyscaffold.extensions.config
module
pyscaffold.extensions.gitlab_ci
module
pyscaffold.extensions.interactive
module
pyscaffold.extensions.namespace
module
pyscaffold.extensions.no_pyproject
module
pyscaffold.extensions.no_skeleton
module
pyscaffold.extensions.no_tox
module
pyscaffold.extensions.pre_commit
module
pyscaffold.extensions.venv
module
pyscaffold.file_system
module
pyscaffold.identification
module
pyscaffold.info
module
pyscaffold.log
module
pyscaffold.operations
module
pyscaffold.repo
module
pyscaffold.shell
module
pyscaffold.structure
module
pyscaffold.templates
module
pyscaffold.termui
module
pyscaffold.toml
module
pyscaffold.update
module
PyScaffoldTooOld
R
RAISE_EXCEPTION (in module pyscaffold.info)
read_pyproject() (in module pyscaffold.info)
read_setupcfg() (in module pyscaffold.info)
reconfigure() (pyscaffold.log.ReportLogger method)
register() (in module pyscaffold.actions)
(pyscaffold.extensions.Extension static method)
ReifiedLeaf (in module pyscaffold.structure)
reify_content() (in module pyscaffold.structure)
reify_leaf() (in module pyscaffold.structure)
reject() (in module pyscaffold.structure)
remove() (in module pyscaffold.dependencies)
(in module pyscaffold.operations)
remove_files() (in module pyscaffold.extensions.no_pyproject)
(in module pyscaffold.extensions.no_skeleton)
(in module pyscaffold.extensions.no_tox)
replace_find_with_find_namespace() (in module pyscaffold.update)
report() (pyscaffold.log.ReportLogger method)
report_done() (in module pyscaffold.actions)
ReportFormatter (class in pyscaffold.log)
ReportLogger (class in pyscaffold.log)
REQ_SPLITTER (in module pyscaffold.dependencies)
resolve_leaf() (in module pyscaffold.structure)
ResolvedLeaf (in module pyscaffold.structure)
rm_rf() (in module pyscaffold.file_system)
run() (in module pyscaffold.cli)
(in module pyscaffold.extensions.venv)
(pyscaffold.shell.ShellCommand method)
run_scaffold() (in module pyscaffold.cli)
RUNTIME (in module pyscaffold.dependencies)
S
save() (in module pyscaffold.extensions.config)
ScaffoldOpts (in module pyscaffold.actions)
(in module pyscaffold.operations)
setdefault() (in module pyscaffold.toml)
setup_cfg() (in module pyscaffold.templates)
shell_command_error2exit_decorator() (in module pyscaffold.shell)
ShellCommand (class in pyscaffold.shell)
ShellCommandException
skip_on_update() (in module pyscaffold.operations)
SPACING (pyscaffold.log.ReportFormatter attribute)
split() (in module pyscaffold.dependencies)
split_args() (in module pyscaffold.extensions.interactive)
store_with() (in module pyscaffold.extensions)
Structure (in module pyscaffold.structure)
STYLES (in module pyscaffold.termui)
SUBJECT_STYLES (pyscaffold.log.ColoredReportFormatter attribute)
supports_color() (in module pyscaffold.termui)
SYSTEM_SUPPORTS_COLOR (in module pyscaffold.termui)
T
TARGET_PREFIX (pyscaffold.log.ColoredReportFormatter attribute)
(pyscaffold.log.ReportFormatter attribute)
tmpfile() (in module pyscaffold.file_system)
TOMLMapping (in module pyscaffold.toml)
U
underscore() (in module pyscaffold.identification)
unregister() (in module pyscaffold.actions)
(pyscaffold.extensions.Extension static method)
update_pyproject_toml() (in module pyscaffold.update)
update_setup_cfg() (in module pyscaffold.update)
username() (in module pyscaffold.info)
V
Venv (class in pyscaffold.extensions.venv)
verify_options_consistency() (in module pyscaffold.actions)
verify_project_dir() (in module pyscaffold.actions)
version_migration() (in module pyscaffold.update)
W
wrap() (in module pyscaffold.extensions.interactive)
wrapped() (pyscaffold.log.ReportLogger property)
Read the Docs
v: v4.0
Versions
latest
stable
v4.0.x
v4.0
v3.3.1
v3.3.x
v3.3
v3.2.3
v3.1
v3.0.3
v2.5.11
v2.4.4
v2.3
v2.2.1
v2.1
v2.0.4
readthedocs-cfg
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.