PyScaffold
3.2.1
Features
Installation
Examples
Configuration
Dependency Management
Migrating to PyScaffold
Extending PyScaffold
Embedding PyScaffold
Cookiecutter Integration
Contributions & Help
FAQ
License
Contributors
Changelog
Module Reference
PyScaffold
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
ActionNotFound
activate() (pyscaffold.api.Extension method)
(pyscaffold.extensions.awesome.AwesomeFiles method)
(pyscaffold.extensions.cookiecutter.Cookiecutter method)
(pyscaffold.extensions.django.Django method)
(pyscaffold.extensions.gitlab_ci.GitLab method)
(pyscaffold.extensions.namespace.Namespace method)
(pyscaffold.extensions.no_skeleton.NoSkeleton method)
(pyscaffold.extensions.pre_commit.PreCommit method)
(pyscaffold.extensions.tox.Tox method)
(pyscaffold.extensions.travis.Travis method)
ACTIVITY_MAXLEN (pyscaffold.log.ReportFormatter attribute)
ACTIVITY_STYLES (pyscaffold.log.ColoredReportFormatter attribute)
add_default_args() (in module pyscaffold.cli)
add_entrypoints() (in module pyscaffold.update)
add_files() (pyscaffold.extensions.gitlab_ci.GitLab method)
(pyscaffold.extensions.pre_commit.PreCommit static method)
(pyscaffold.extensions.tox.Tox method)
(pyscaffold.extensions.travis.Travis method)
add_namespace() (in module pyscaffold.extensions.namespace)
add_section() (pyscaffold.contrib.configupdater.ConfigUpdater method)
add_setup_requires() (in module pyscaffold.update)
add_tag() (in module pyscaffold.repo)
append() (pyscaffold.contrib.configupdater.ParsingError method)
apply_update_rule_to_file() (in module pyscaffold.update)
apply_update_rules() (in module pyscaffold.update)
augment_cli() (pyscaffold.api.Extension method)
(pyscaffold.extensions.cookiecutter.Cookiecutter method)
(pyscaffold.extensions.namespace.Namespace method)
author_date (pyscaffold.info.GitEnv attribute)
author_email (pyscaffold.info.GitEnv attribute)
author_name (pyscaffold.info.GitEnv attribute)
authors() (in module pyscaffold.templates)
AwesomeFiles (class in pyscaffold.extensions.awesome)
B
best_fit_license() (in module pyscaffold.info)
build_cmd_docs() (in module pyscaffold.integration)
C
changelog() (in module pyscaffold.templates)
chdir() (in module pyscaffold.utils)
check_git() (in module pyscaffold.info)
check_setuptools_version() (in module pyscaffold.utils)
ColoredReportFormatter (class in pyscaffold.log)
command_exists() (in module pyscaffold.shell)
committer_date (pyscaffold.info.GitEnv attribute)
committer_email (pyscaffold.info.GitEnv attribute)
committer_name (pyscaffold.info.GitEnv attribute)
ConfigUpdater (class in pyscaffold.contrib.configupdater)
configure_logger() (in module pyscaffold.log)
conftest_py() (in module pyscaffold.templates)
CONTEXT_PREFIX (pyscaffold.log.ColoredReportFormatter attribute)
(pyscaffold.log.ReportFormatter attribute)
Cookiecutter (class in pyscaffold.extensions.cookiecutter)
copy() (pyscaffold.log.ReportLogger method)
coveragerc() (in module pyscaffold.templates)
create_cookiecutter() (in module pyscaffold.extensions.cookiecutter)
create_cookiecutter_parser() (in module pyscaffold.extensions.cookiecutter)
create_directory() (in module pyscaffold.utils)
create_django_proj() (in module pyscaffold.extensions.django)
create_file() (in module pyscaffold.utils)
create_namespace_parser() (in module pyscaffold.extensions.namespace)
create_padding() (pyscaffold.log.ReportFormatter method)
create_project() (in module pyscaffold.api)
create_structure() (in module pyscaffold.structure)
curses_available() (in module pyscaffold.termui)
D
dasherize() (in module pyscaffold.utils)
decorate() (in module pyscaffold.termui)
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)
(pyscaffold.extensions.cookiecutter.MissingTemplate attribute)
(pyscaffold.extensions.cookiecutter.NotInstalled attribute)
(pyscaffold.extensions.django.DjangoAdminNotInstalled attribute)
(pyscaffold.warnings.UpdateNotSupported attribute)
define_awesome_files() (pyscaffold.extensions.awesome.AwesomeFiles method)
define_structure() (in module pyscaffold.structure)
DirectoryAlreadyExists
DirectoryDoesNotExist
discover_actions() (in module pyscaffold.api)
Django (class in pyscaffold.extensions.django)
django_admin (in module pyscaffold.shell)
DjangoAdminNotInstalled
DuplicateOptionError
DuplicateSectionError
E
email() (in module pyscaffold.info)
enforce_cookiecutter_options() (in module pyscaffold.extensions.cookiecutter)
enforce_django_options() (in module pyscaffold.extensions.django)
enforce_namespace_options() (in module pyscaffold.extensions.namespace)
ensure() (in module pyscaffold.api.helpers)
exceptions2exit() (in module pyscaffold.utils)
Extension (class in pyscaffold.api)
F
filename() (pyscaffold.contrib.configupdater.ParsingError property)
FileOp (class in pyscaffold.structure)
flag() (pyscaffold.api.Extension property)
format() (pyscaffold.log.ReportFormatter method)
format_activity() (pyscaffold.log.ColoredReportFormatter method)
(pyscaffold.log.ReportFormatter method)
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 attribute)
G
get() (pyscaffold.contrib.configupdater.ConfigUpdater method)
get_curr_version() (in module pyscaffold.update)
get_default_options() (in module pyscaffold.api)
get_git_cmd() (in module pyscaffold.shell)
get_git_root() (in module pyscaffold.repo)
get_id() (in module pyscaffold.utils)
get_setup_requires_version() (in module pyscaffold.utils)
get_template() (in module pyscaffold.templates)
git (in module pyscaffold.shell)
git_tree_add() (in module pyscaffold.repo)
GitDirtyWorkspace
GitEnv (class in pyscaffold.info)
gitignore() (in module pyscaffold.templates)
gitignore_empty() (in module pyscaffold.templates)
GitLab (class in pyscaffold.extensions.gitlab_ci)
gitlab_ci() (in module pyscaffold.templates)
GitNotConfigured
GitNotInstalled
H
handler (pyscaffold.log.ReportLogger attribute)
has_option() (pyscaffold.contrib.configupdater.ConfigUpdater method)
has_section() (pyscaffold.contrib.configupdater.ConfigUpdater method)
I
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.api)
instruct_user() (pyscaffold.extensions.pre_commit.PreCommit static method)
InvalidIdentifier
invoke_action() (in module pyscaffold.update)
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_valid_identifier() (in module pyscaffold.utils)
isatty() (in module pyscaffold.termui)
isort_cfg() (in module pyscaffold.templates)
items() (pyscaffold.contrib.configupdater.ConfigUpdater method)
L
level() (pyscaffold.log.ReportLogger property)
levenshtein() (in module pyscaffold.utils)
license() (in module pyscaffold.templates)
licenses (in module pyscaffold.templates)
list_actions() (in module pyscaffold.cli)
local_version2str() (in module pyscaffold.integration)
LOG_STYLES (pyscaffold.log.ColoredReportFormatter attribute)
logger (in module pyscaffold.api.helpers)
(in module pyscaffold.log)
M
main() (in module pyscaffold.cli)
make_valid_identifier() (in module pyscaffold.utils)
merge() (in module pyscaffold.api.helpers)
MissingSectionHeaderError
MissingTemplate
modify() (in module pyscaffold.api.helpers)
module
pyscaffold
pyscaffold.api
pyscaffold.api.helpers
pyscaffold.cli
pyscaffold.contrib
pyscaffold.contrib.configupdater
pyscaffold.exceptions
pyscaffold.extensions
pyscaffold.extensions.awesome
pyscaffold.extensions.cookiecutter
pyscaffold.extensions.django
pyscaffold.extensions.gitlab_ci
pyscaffold.extensions.namespace
pyscaffold.extensions.no_skeleton
pyscaffold.extensions.pre_commit
pyscaffold.extensions.tox
pyscaffold.extensions.travis
pyscaffold.info
pyscaffold.integration
pyscaffold.log
pyscaffold.repo
pyscaffold.shell
pyscaffold.structure
pyscaffold.templates
pyscaffold.termui
pyscaffold.update
pyscaffold.utils
pyscaffold.warnings
move() (in module pyscaffold.utils)
move_old_package() (in module pyscaffold.extensions.namespace)
mutually_exclusive (pyscaffold.api.Extension attribute)
(pyscaffold.extensions.cookiecutter.Cookiecutter attribute)
(pyscaffold.extensions.django.Django attribute)
N
Namespace (class in pyscaffold.extensions.namespace)
namespace() (in module pyscaffold.templates)
nesting (pyscaffold.log.ReportLogger attribute)
NO_CREATE (in module pyscaffold.api.helpers)
(pyscaffold.structure.FileOp attribute)
NO_OVERWRITE (in module pyscaffold.api.helpers)
(pyscaffold.structure.FileOp attribute)
NoConfigFileReadError
NONSPACECRE (pyscaffold.contrib.configupdater.ConfigUpdater attribute)
NoOptionError
NoPyScaffoldProject
NoSectionError
NoSkeleton (class in pyscaffold.extensions.no_skeleton)
NotInstalled
O
OldSetuptools
OPTCRE (pyscaffold.contrib.configupdater.ConfigUpdater attribute)
OPTCRE_NV (pyscaffold.contrib.configupdater.ConfigUpdater attribute)
options() (pyscaffold.contrib.configupdater.ConfigUpdater method)
optionxform() (pyscaffold.contrib.configupdater.ConfigUpdater method)
P
parse_args() (in module pyscaffold.cli)
ParsingError
pre_commit_config() (in module pyscaffold.templates)
PreCommit (class in pyscaffold.extensions.pre_commit)
prepare_namespace() (in module pyscaffold.utils)
process() (pyscaffold.log.ReportLogger method)
process_opts() (in module pyscaffold.cli)
project() (in module pyscaffold.info)
pyscaffold
module
pyscaffold.api
module
pyscaffold.api.helpers
module
pyscaffold.cli
module
pyscaffold.contrib
module
pyscaffold.contrib.configupdater
module
pyscaffold.exceptions
module
pyscaffold.extensions
module
pyscaffold.extensions.awesome
module
pyscaffold.extensions.cookiecutter
module
pyscaffold.extensions.django
module
pyscaffold.extensions.gitlab_ci
module
pyscaffold.extensions.namespace
module
pyscaffold.extensions.no_skeleton
module
pyscaffold.extensions.pre_commit
module
pyscaffold.extensions.tox
module
pyscaffold.extensions.travis
module
pyscaffold.info
module
pyscaffold.integration
module
pyscaffold.log
module
pyscaffold.repo
module
pyscaffold.shell
module
pyscaffold.structure
module
pyscaffold.templates
module
pyscaffold.termui
module
pyscaffold.update
module
pyscaffold.utils
module
pyscaffold.warnings
module
pyscaffold_keyword() (in module pyscaffold.integration)
PyScaffoldTooOld
R
read() (pyscaffold.contrib.configupdater.ConfigUpdater method)
read_file() (pyscaffold.contrib.configupdater.ConfigUpdater method)
read_setupcfg() (in module pyscaffold.update)
read_string() (pyscaffold.contrib.configupdater.ConfigUpdater method)
readme() (in module pyscaffold.templates)
register() (in module pyscaffold.api.helpers)
(pyscaffold.api.Extension static method)
reject() (in module pyscaffold.api.helpers)
remove_files() (pyscaffold.extensions.no_skeleton.NoSkeleton method)
remove_option() (pyscaffold.contrib.configupdater.ConfigUpdater method)
remove_section() (pyscaffold.contrib.configupdater.ConfigUpdater method)
report() (pyscaffold.log.ReportLogger method)
ReportFormatter (class in pyscaffold.log)
ReportLogger (class in pyscaffold.log)
requirements() (in module pyscaffold.templates)
run() (in module pyscaffold.cli)
run_scaffold() (in module pyscaffold.cli)
S
scm_find_files() (in module pyscaffold.contrib)
scm_get_local_dirty_tag() (in module pyscaffold.contrib)
scm_get_local_node_and_date() (in module pyscaffold.contrib)
scm_guess_next_dev_version() (in module pyscaffold.contrib)
scm_parse_archival() (in module pyscaffold.contrib)
scm_parse_git() (in module pyscaffold.contrib)
scm_parse_hg() (in module pyscaffold.contrib)
scm_parse_pkginfo() (in module pyscaffold.contrib)
scm_postrelease_version() (in module pyscaffold.contrib)
SECTCRE (pyscaffold.contrib.configupdater.ConfigUpdater attribute)
sections() (pyscaffold.contrib.configupdater.ConfigUpdater method)
sections_blocks() (pyscaffold.contrib.configupdater.ConfigUpdater method)
set() (pyscaffold.contrib.configupdater.ConfigUpdater method)
setup_cfg() (in module pyscaffold.templates)
setup_py() (in module pyscaffold.templates)
setuptools_scm_config() (in module pyscaffold.integration)
shell_command_error2exit_decorator() (in module pyscaffold.shell)
ShellCommand (class in pyscaffold.shell)
ShellCommandException
skeleton() (in module pyscaffold.templates)
SPACING (pyscaffold.log.ReportFormatter attribute)
sphinx_authors() (in module pyscaffold.templates)
sphinx_changelog() (in module pyscaffold.templates)
sphinx_conf() (in module pyscaffold.templates)
sphinx_index() (in module pyscaffold.templates)
sphinx_license() (in module pyscaffold.templates)
sphinx_makefile() (in module pyscaffold.templates)
SUBJECT_STYLES (pyscaffold.log.ColoredReportFormatter attribute)
supports_color() (in module pyscaffold.termui)
T
TARGET_PREFIX (pyscaffold.log.ColoredReportFormatter attribute)
(pyscaffold.log.ReportFormatter attribute)
test_skeleton() (in module pyscaffold.templates)
to_dict() (pyscaffold.contrib.configupdater.ConfigUpdater method)
Tox (class in pyscaffold.extensions.tox)
tox() (in module pyscaffold.templates)
Travis (class in pyscaffold.extensions.travis)
travis() (in module pyscaffold.templates)
travis_install() (in module pyscaffold.templates)
U
unregister() (in module pyscaffold.api.helpers)
(pyscaffold.api.Extension static method)
update_file() (pyscaffold.contrib.configupdater.ConfigUpdater method)
update_pyscaffold_version() (in module pyscaffold.update)
UpdateNotSupported
username() (in module pyscaffold.info)
V
validate_format() (pyscaffold.contrib.configupdater.ConfigUpdater method)
verify_options_consistency() (in module pyscaffold.api)
verify_project_dir() (in module pyscaffold.api)
version2str() (in module pyscaffold.integration)
version_migration() (in module pyscaffold.update)
W
warn_about_deprecated_pyscaffold() (in module pyscaffold.contrib)
wrapped (pyscaffold.log.ReportLogger attribute)
write() (pyscaffold.contrib.configupdater.ConfigUpdater method)
write_pbr_json() (in module pyscaffold.contrib)