Package: daves-dev-tools
daves-dev-toolsThis project provides command line utilities for performing common python
development tasks.InstallationYou can install daves-dev-tools with pip:pip3installdaves-dev-toolsUsageCommand Line Interface$daves-dev-tools-hUsage:daves-dev-tools <command> [options]Commands:git                         Tools for interacting with git repos.requirements                Tools for managing requirement versions.install-editable            Auto-discover and install packages in "develop"mode used by the current environment or by one ormore specified packages/projects.make-typed                  Configure your project to indicate to `mypy` thatthe contents are type-hinted.uninstall-all               Uninstall all distributions from the currentpython environment except for those explicitlyspecified (and their dependencies).clean                       Delete files from your project which are ignoredby `git`, excepting files matching specifiedexclusion patterns.distribute                  Build and distribute to PYPI (or other indexes)with one command.daves-dev-tools requirements updateSee the documentation fordependence update.
This command is now part of thedependencedistribution/project.daves-dev-toolswrapsdependencefor backwards compatibility,
however future major versions ofdaves-dev-toolsmay drop this command,
since it is now redundant.daves-dev-tools requirements freezeSee the documentation fordependence freeze.
This command is now part of thedependencedistribution/project.daves-dev-toolswrapsdependencefor backwards compatibility,
however future major versions ofdaves-dev-toolsmay drop this command,
since it is now redundant.daves-dev-tools install-editable$daves-dev-toolsinstall-editable-husage: daves-dev-tools install-editable [-h] [-r REQUIREMENT] [-d DIRECTORY][-e EXCLUDE] [-ed EXCLUDE_DIRECTORY][-edre EXCLUDE_DIRECTORY_REGULAR_EXPRESSION][-dr] [-ie]This command will attempt to find and install, in develop (editable) mode, allpackages which are installed in the current python environment. If one or more`requirement` file paths or specifiers are provided, installation will belimited to the dependencies identified (recursively) by these requirements.Exclusions can be specified using the `-e` parameter. Directories can beexcluded by passing regular expressions to the `-edre` parameter. Anyarguments passed not matching those specified below will be passed on to `pipinstall` (see `pip install -h` for additionally available arguments).optional arguments:-h, --help            show this help message and exit-r REQUIREMENT, --requirement REQUIREMENTOne or more requirement specifiers, requirement filepaths, or configuration file paths (setup.cfg,setup.py, pyproject.toml, tox.ini, etc.). If provided,only dependencies of these requirements will beinstalled.-d DIRECTORY, --directory DIRECTORYA directory in which to search for requirements. Bydefault, the directory above the current directory issearched. This argument may be passed more than onceto include multiple locations.-e EXCLUDE, --exclude EXCLUDEA comma-separated list of distribution names toexclude-ed EXCLUDE_DIRECTORY, --exclude-directory EXCLUDE_DIRECTORYOne or more glob patterns indicating directories toexclude. This argument may be expressed as a pathrelative to the current.-edre EXCLUDE_DIRECTORY_REGULAR_EXPRESSION, --exclude-directory-regular-expression EXCLUDE_DIRECTORY_REGULAR_EXPRESSIONDirectories matching this regular expression will beexcluded when searching for setup locations Thisargument may be passed more than once to excludedirectories matching more than one regular expression.The default for this argument is equivalent to `-edre'^[.~].*$' -edre '^venv$' -edre '^site-packages$'`.Unlike for *--exclude-directory*, these expressionsapply only to the directory *name*, and no attempt toresolve relative paths is made.-dr, --dry-run        Print, but do not execute, all `pip install` commands-ie, --include-extrasInstall all extras for all discovered distributionsdaves-dev-tools make-typed$daves-dev-toolsmake-typed-husage: daves-dev-tools make-typed [-h] pathAdd **/py.typed files and alter the setup.cfg such that a distribution's packages will be identifiable as fully type-hintedpositional arguments:path        A project directory (where the setup.py and/or setup.cfg file are located)optional arguments:-h, --help  show this help message and exitdaves-dev-tools uninstall-all$daves-dev-toolsuninstall-all-husage: daves-dev-tools uninstall-all [-h] [-e EXCLUDE] [-dr]This command will uninstall all distributions installed in the same environment as that from which this command is executed,excluding any specified by `-e EXCLUDE`.optional arguments:-h, --help            show this help message and exit-e EXCLUDE, --exclude EXCLUDEOne or more distribution specifiers, requirement files, setup.cfg files, pyproject.toml files, ortox.ini files denoting packages to exclude (along with all of their requirements) from thosedistributions to be uninstalled-dr, --dry-run        Print, but do not execute, the assembled `pip uninstall` command which, absent this flag, would beexecuteddaves-dev-tools git download$daves-dev-toolsgitdownload-husage: daves-dev-tools git download [-h] [-b BRANCH] [-d DIRECTORY] [-e]repo [file [file ...]]Download files from a git repository matching one or more specified file namesor glob patternspositional arguments:repo                  Reference repositoryfile                  One or more `glob` pattern(s) indicating a specificfile or files to include. If not provided, all filesin the repository will be included.optional arguments:-h, --help            show this help message and exit-b BRANCH, --branch BRANCHRetrieve files from BRANCH instead of the remote'sHEAD-d DIRECTORY, --directory DIRECTORYThe directory under which to save matched files. Ifnot provided, files will be saved under the currentdirectory.-e, --echo            Print the downloaded file pathsdaves-dev-tools git tag-version$daves-dev-toolsgittag-version-husage: daves-dev-tools git tag-version [-h] [-m MESSAGE] [directory]Tag your repo with the python package version, if a tag for that versiondoesn't already exist.positional arguments:directory             Your project directory. If not provided, the currentdirectory will be used.optional arguments:-h, --help            show this help message and exit-m MESSAGE, --message MESSAGEThe tag message. If not provided, the new versionnumber is used.daves-dev-tools clean$daves-dev-toolsclean-husage: daves-dev-tools clean [-h] [-e EXCLUDE] [-dr] [directory]This command removes all files from your project directory which are ignoredby git, unless matching one of the EXCLUDE glob patterns.positional arguments:directory             The root directory for the project.optional arguments:-h, --help            show this help message and exit-e EXCLUDE, --exclude EXCLUDEOne or more glob patterns indicating files/directoriesto exclude from cleanup. The default values are: `-e.idea -e .vscode -e .git -e venv`.-dr, --dry-run        Instead of executing the cleanup, just print the shellcommands (a list of `rm FILE` commands).daves-dev-tools distribute$daves-dev-toolsdistribute-husage: daves-dev-tools distribute [-h][-r REPOSITORY] [--repository-url REPOSITORY_URL][-s] [--sign-with SIGN_WITH] [-i IDENTITY] [-u USERNAME][-p PASSWORD] [--non-interactive] [-c COMMENT][--config-file CONFIG_FILE] [--skip-existing][--cert path] [--client-cert path] [--verbose][--disable-progress-bar][directory]positional arguments:directory             The root directory path for the project.optional arguments:-h, --help            show this help message and exit-r REPOSITORY, --repository REPOSITORYThe repository (package index) to upload the packageto. Should be a section in the config file (default:pypi). (Can also be set via TWINE_REPOSITORYenvironment variable.)--repository-url REPOSITORY_URLThe repository (package index) URL to upload thepackage to. This overrides --repository. (Can also beset via TWINE_REPOSITORY_URL environment variable.)-s, --sign            Sign files to upload using GPG.--sign-with SIGN_WITHGPG program used to sign uploads (default: gpg).-i IDENTITY, --identity IDENTITYGPG identity used to sign files.-u USERNAME, --username USERNAMEThe username to authenticate to the repository(package index) as. (Can also be set viaTWINE_USERNAME environment variable.)-p PASSWORD, --password PASSWORDThe password to authenticate to the repository(package index) with. (Can also be set viaTWINE_PASSWORD environment variable.)--non-interactive     Do not interactively prompt for username/password ifthe required credentials are missing. (Can also be setvia TWINE_NON_INTERACTIVE environment variable.)-c COMMENT, --comment COMMENTThe comment to include with the distribution file.--config-file CONFIG_FILEThe .pypirc config file to use.--skip-existing       Continue uploading files if one already exists. (Onlyvalid when uploading to PyPI. Other implementationsmay not support this.)--cert path           Path to alternate CA bundle (can also be set viaTWINE_CERT environment variable).--client-cert path    Path to SSL client certificate, a single filecontaining the private key and the certificate in PEMformat.--verbose             Show verbose output.--disable-progress-barDisable the progress bar.