PyScaffold
v3.3.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
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
absolute_root (pyscaffold.contrib.setuptools_scm.config.Configuration attribute)
ActionNotFound
activate() (pyscaffold.api.Extension method)
(pyscaffold.extensions.cirrus.Cirrus 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() (in module pyscaffold.extensions.cirrus)
(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)
allow_hosts (pyscaffold.contrib.ptr.CustomizedDist attribute)
append() (pyscaffold.contrib.configupdater.ParsingError method)
apply_update_rule_to_file() (in module pyscaffold.update)
apply_update_rules() (in module pyscaffold.update)
archival_to_version() (in module pyscaffold.contrib.setuptools_scm.hg)
augment_cli() (pyscaffold.api.Extension method)
(pyscaffold.extensions.cirrus.Cirrus 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)
B
best_fit_license() (in module pyscaffold.info)
build_cmd_docs() (in module pyscaffold.integration)
C
callable_or_entrypoint() (in module pyscaffold.contrib.setuptools_scm.version)
changelog() (in module pyscaffold.templates)
chdir() (in module pyscaffold.utils)
check_git() (in module pyscaffold.info)
check_setuptools_version() (in module pyscaffold.utils)
Cirrus (class in pyscaffold.extensions.cirrus)
cirrus_descriptor() (in module pyscaffold.extensions.cirrus)
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)
Configuration (class in pyscaffold.contrib.setuptools_scm.config)
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)
count_all_nodes() (pyscaffold.contrib.setuptools_scm.git.GitWorkdir 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)
CustomizedDist (class in pyscaffold.contrib.ptr)
D
dasherize() (in module pyscaffold.utils)
data_from_mime() (in module pyscaffold.contrib.setuptools_scm.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_structure() (in module pyscaffold.structure)
DeprecatedPyTest (class in pyscaffold.integration)
DirectoryAlreadyExists
DirectoryDoesNotExist
discover_actions() (in module pyscaffold.api)
Django (class in pyscaffold.extensions.django)
django_admin (in module pyscaffold.shell)
DjangoAdminNotInstalled
do() (in module pyscaffold.contrib.setuptools_scm.utils)
do_ex() (in module pyscaffold.contrib.setuptools_scm.utils)
(pyscaffold.contrib.setuptools_scm.git.GitWorkdir method)
dst() (pyscaffold.contrib.setuptools_scm.utils.UTC method)
dump_version() (in module pyscaffold.contrib.setuptools_scm)
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)
ensure_setuptools_version() (pyscaffold.contrib.ptr.PyTest static method)
ensure_stripped_str() (in module pyscaffold.contrib.setuptools_scm.utils)
ERROR_INVALID_NAME (in module pyscaffold.utils)
exact (pyscaffold.contrib.setuptools_scm.version.ScmVersion attribute)
exceptions2exit() (in module pyscaffold.utils)
Extension (class in pyscaffold.api)
extra (pyscaffold.contrib.setuptools_scm.version.ScmVersion attribute)
F
fail_on_shallow() (in module pyscaffold.contrib.setuptools_scm.git)
fallback_root (pyscaffold.contrib.setuptools_scm.config.Configuration attribute)
fallback_version() (in module pyscaffold.contrib.setuptools_scm.hacks)
fetch_build_egg() (pyscaffold.contrib.ptr.CustomizedDist method)
fetch_on_shallow() (in module pyscaffold.contrib.setuptools_scm.git)
fetch_shallow() (pyscaffold.contrib.setuptools_scm.git.GitWorkdir method)
filename (pyscaffold.contrib.configupdater.ParsingError attribute)
FileOp (class in pyscaffold.structure)
finalize_options() (pyscaffold.contrib.ptr.PyTest method)
find_files() (in module pyscaffold.contrib.setuptools_scm.integration)
flag (pyscaffold.api.Extension attribute)
format() (pyscaffold.log.ReportFormatter method)
format_activity() (pyscaffold.log.ColoredReportFormatter method)
(pyscaffold.log.ReportFormatter method)
format_choice() (pyscaffold.contrib.setuptools_scm.version.ScmVersion method)
format_context() (pyscaffold.log.ReportFormatter method)
format_default() (pyscaffold.log.ColoredReportFormatter method)
(pyscaffold.log.ReportFormatter method)
format_next_version() (pyscaffold.contrib.setuptools_scm.version.ScmVersion 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)
format_version() (in module pyscaffold.contrib.setuptools_scm.version)
format_with() (pyscaffold.contrib.setuptools_scm.version.ScmVersion method)
formatter (pyscaffold.log.ReportLogger attribute)
from_file() (pyscaffold.contrib.setuptools_scm.config.Configuration class method)
from_potential_worktree() (pyscaffold.contrib.setuptools_scm.git.GitWorkdir class method)
function_has_arg() (in module pyscaffold.contrib.setuptools_scm.utils)
G
get() (pyscaffold.contrib.configupdater.ConfigUpdater method)
get_branch() (pyscaffold.contrib.setuptools_scm.git.GitWorkdir 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_graph_distance() (in module pyscaffold.contrib.setuptools_scm.hg)
get_id() (in module pyscaffold.utils)
get_latest_normalizable_tag() (in module pyscaffold.contrib.setuptools_scm.hg)
get_local_dirty_tag() (in module pyscaffold.contrib.setuptools_scm.version)
get_local_node_and_date() (in module pyscaffold.contrib.setuptools_scm.version)
get_local_node_and_timestamp() (in module pyscaffold.contrib.setuptools_scm.version)
get_no_local_node() (in module pyscaffold.contrib.setuptools_scm.version)
get_setup_requires_version() (in module pyscaffold.utils)
get_template() (in module pyscaffold.templates)
get_version() (in module pyscaffold.contrib.setuptools_scm)
git (in module pyscaffold.shell)
git_find_files() (in module pyscaffold.contrib.setuptools_scm.file_finder_git)
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
GitWorkdir (class in pyscaffold.contrib.setuptools_scm.git)
guess_next_dev_version() (in module pyscaffold.contrib.setuptools_scm.version)
guess_next_simple_semver() (in module pyscaffold.contrib.setuptools_scm.version)
guess_next_version() (in module pyscaffold.contrib.setuptools_scm.version)
H
handler (pyscaffold.log.ReportLogger attribute)
has_command() (in module pyscaffold.contrib.setuptools_scm.utils)
has_option() (pyscaffold.contrib.configupdater.ConfigUpdater method)
has_section() (pyscaffold.contrib.configupdater.ConfigUpdater method)
hg_find_files() (in module pyscaffold.contrib.setuptools_scm.file_finder_hg)
I
IncludeExtensions (class in pyscaffold.extensions.cirrus)
indent() (pyscaffold.log.ReportLogger method)
index_url (pyscaffold.contrib.ptr.CustomizedDist attribute)
infer_version() (in module pyscaffold.contrib.setuptools_scm.integration)
init() (in module pyscaffold.templates)
init_colorama() (in module pyscaffold.termui)
init_commit_repo() (in module pyscaffold.repo)
init_git() (in module pyscaffold.api)
initialize_options() (pyscaffold.contrib.ptr.PyTest method)
(pyscaffold.integration.DeprecatedPyTest method)
install_dists() (pyscaffold.contrib.ptr.PyTest method)
install_extra_dists() (pyscaffold.contrib.ptr.PyTest method)
instruct_user() (pyscaffold.extensions.pre_commit.PreCommit static method)
InvalidIdentifier
invoke_action() (in module pyscaffold.update)
is_dirty() (pyscaffold.contrib.setuptools_scm.git.GitWorkdir method)
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.utils)
is_shallow() (pyscaffold.contrib.setuptools_scm.git.GitWorkdir method)
is_valid_identifier() (in module pyscaffold.utils)
isatty() (in module pyscaffold.termui)
isort_cfg() (in module pyscaffold.templates)
items() (pyscaffold.contrib.configupdater.ConfigUpdater method)
iter_matching_entrypoints() (in module pyscaffold.contrib.setuptools_scm.discover)
L
level (pyscaffold.log.ReportLogger attribute)
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)
localize_path() (in module pyscaffold.utils)
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)
marker_passes() (pyscaffold.contrib.ptr.PyTest static method)
merge() (in module pyscaffold.api.helpers)
meta() (in module pyscaffold.contrib.setuptools_scm.version)
MissingSectionHeaderError
MissingTemplate
modify() (in module pyscaffold.api.helpers)
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_git_env() (in module pyscaffold.contrib.setuptools_scm.utils)
NO_OVERWRITE (in module pyscaffold.api.helpers)
(pyscaffold.structure.FileOp attribute)
NoConfigFileReadError
node() (pyscaffold.contrib.setuptools_scm.git.GitWorkdir method)
NONSPACECRE (pyscaffold.contrib.configupdater.ConfigUpdater attribute)
NoOptionError
NoPyScaffoldProject
NoSectionError
NoSkeleton (class in pyscaffold.extensions.no_skeleton)
NotInstalled
O
OldSetuptools
on_ro_error() (in module pyscaffold.utils)
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() (in module pyscaffold.contrib.setuptools_scm.git)
(in module pyscaffold.contrib.setuptools_scm.hg)
parse_archival() (in module pyscaffold.contrib.setuptools_scm.hg)
parse_args() (in module pyscaffold.cli)
parse_pip_egg_info() (in module pyscaffold.contrib.setuptools_scm.hacks)
parse_pkginfo() (in module pyscaffold.contrib.setuptools_scm.hacks)
ParsingError
postrelease_version() (in module pyscaffold.contrib.setuptools_scm.version)
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.contrib.ptr (module)
pyscaffold.contrib.setuptools_scm (module)
pyscaffold.contrib.setuptools_scm.config (module)
pyscaffold.contrib.setuptools_scm.discover (module)
pyscaffold.contrib.setuptools_scm.file_finder (module)
pyscaffold.contrib.setuptools_scm.file_finder_git (module)
pyscaffold.contrib.setuptools_scm.file_finder_hg (module)
pyscaffold.contrib.setuptools_scm.git (module)
pyscaffold.contrib.setuptools_scm.hacks (module)
pyscaffold.contrib.setuptools_scm.hg (module)
pyscaffold.contrib.setuptools_scm.integration (module)
pyscaffold.contrib.setuptools_scm.utils (module)
pyscaffold.contrib.setuptools_scm.version (module)
pyscaffold.exceptions (module)
pyscaffold.extensions (module)
pyscaffold.extensions.cirrus (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
PyTest (class in pyscaffold.contrib.ptr)
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)
reconfigure() (pyscaffold.log.ReportLogger method)
register() (in module pyscaffold.api.helpers)
(pyscaffold.api.Extension static method)
reject() (in module pyscaffold.api.helpers)
relative_to (pyscaffold.contrib.setuptools_scm.config.Configuration attribute)
release_branch_semver() (in module pyscaffold.contrib.setuptools_scm.version)
release_branch_semver_version() (in module pyscaffold.contrib.setuptools_scm.version)
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)
rm_rf() (in module pyscaffold.utils)
root (pyscaffold.contrib.setuptools_scm.config.Configuration attribute)
run() (in module pyscaffold.cli)
(pyscaffold.contrib.ptr.PyTest method)
run_scaffold() (in module pyscaffold.cli)
run_tests() (pyscaffold.contrib.ptr.PyTest method)
S
scm_find_files() (in module pyscaffold.contrib)
(in module pyscaffold.contrib.setuptools_scm.file_finder)
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)
ScmVersion (class in pyscaffold.contrib.setuptools_scm.version)
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)
SetuptoolsOutdatedWarning
shell_command_error2exit_decorator() (in module pyscaffold.shell)
ShellCommand (class in pyscaffold.shell)
ShellCommandException
simplified_semver_version() (in module pyscaffold.contrib.setuptools_scm.version)
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
tag_regex (pyscaffold.contrib.setuptools_scm.config.Configuration attribute)
tag_to_version() (in module pyscaffold.contrib.setuptools_scm.version)
tags_to_versions() (in module pyscaffold.contrib.setuptools_scm.version)
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)
trace() (in module pyscaffold.contrib.setuptools_scm.utils)
trace_exception() (in module pyscaffold.contrib.setuptools_scm.utils)
Travis (class in pyscaffold.extensions.travis)
travis() (in module pyscaffold.templates)
travis_install() (in module pyscaffold.templates)
tzname() (pyscaffold.contrib.setuptools_scm.utils.UTC method)
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
user_options (pyscaffold.contrib.ptr.PyTest attribute)
username() (in module pyscaffold.info)
UTC (class in pyscaffold.contrib.setuptools_scm.utils)
utcoffset() (pyscaffold.contrib.setuptools_scm.utils.UTC method)
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_from_scm() (in module pyscaffold.contrib.setuptools_scm)
version_keyword() (in module pyscaffold.contrib.setuptools_scm.integration)
version_migration() (in module pyscaffold.update)
W
warn_about_deprecated_pyscaffold() (in module pyscaffold.contrib)
warn_on_shallow() (in module pyscaffold.contrib.setuptools_scm.git)
wrapped (pyscaffold.log.ReportLogger attribute)
write() (pyscaffold.contrib.configupdater.ConfigUpdater method)
write_pbr_json() (in module pyscaffold.contrib)
Read the Docs
v: v3.3.1
Versions
latest
stable
v4.0.x
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
.