Merge pull request #8 from findtopher/topher/add_dev_to_cli

Add `dev` to cli
vemel · Nov 14, 2023 · 16787b2 · 16787b2
2 parents f23044d + 83235f0
commit 16787b2
Show file tree

Hide file tree

Showing 22 changed files with 554 additions and 410 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,16 @@ and this project adheres to
 [PEP 440 -- Version Identification and Dependency Specification](https://www.python.org/dev/peps/pep-0440/).
 
 ## [Unreleased]
+### Added
+- `[api]` added `bump_dev()` functionality and tests
+- `[cli]` added support for `dev` in `bump`, `get`, and `set` along with tests
+
+### Changed
+- `[packaging]` updated dependencies (now `poetry install` works on Apple M1)
+
+### Fixed
+- `[cli]` fixed typo in `help` output
+- `[api]` fixed typo in End of Line fixer
 
 ## [1.8.0] - 2021-03-16
 ### Added

diff --git a/docs/newversion/cli_parser.md b/docs/newversion/cli_parser.md
@@ -1,6 +1,6 @@
 # Cli Parser
 
-> Auto-generated documentation for [newversion.cli_parser](https://github.com/vemel/newversion//blob/main/newversion/cli_parser.py) module.
+> Auto-generated documentation for [newversion.cli_parser](https://github.com/vemel/newversion/blob/main/newversion/cli_parser.py) module.
 
 Main CLI parser.
 
@@ -10,7 +10,7 @@ Main CLI parser.
 
 ## get_stdin
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/cli_parser.py#L14)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/cli_parser.py#L14)
 
 ```python
 def get_stdin() -> Version:
@@ -28,7 +28,7 @@ Parsed version.
 
 ## parse_args
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/cli_parser.py#L31)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/cli_parser.py#L31)
 
 ```python
 def parse_args(args: Sequence[str]) -> argparse.Namespace:

diff --git a/docs/newversion/constants.md b/docs/newversion/constants.md
@@ -1,6 +1,6 @@
 # Constants
 
-> Auto-generated documentation for [newversion.constants](https://github.com/vemel/newversion//blob/main/newversion/constants.py) module.
+> Auto-generated documentation for [newversion.constants](https://github.com/vemel/newversion/blob/main/newversion/constants.py) module.
 
 Constants used in project.
 
@@ -10,7 +10,7 @@ Constants used in project.
 
 ## Commands
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/constants.py#L26)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/constants.py#L26)
 
 ```python
 class Commands():
@@ -20,7 +20,7 @@ CLI commands
 
 ## VersionParts
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/constants.py#L8)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/constants.py#L8)
 
 ```python
 class VersionParts():

diff --git a/docs/newversion/eol_fixer.md b/docs/newversion/eol_fixer.md
@@ -1,8 +1,8 @@
 # EOLFixer
 
-> Auto-generated documentation for [newversion.eol_fixer](https://github.com/vemel/newversion//blob/main/newversion/eol_fixer.py) module.
+> Auto-generated documentation for [newversion.eol_fixer](https://github.com/vemel/newversion/blob/main/newversion/eol_fixer.py) module.
 
-Converter between Unix and WIndows line endings.
+Converter between Unix and Windows line endings.
 
 - [newversion](../README.md#newversion---your-version-manager) / [Modules](../MODULES.md#newversion-modules) / [Newversion](index.md#newversion) / EOLFixer
     - [EOLFixer](#eolfixer)
@@ -14,17 +14,17 @@ Converter between Unix and WIndows line endings.
 
 ## EOLFixer
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/eol_fixer.py#L6)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/eol_fixer.py#L6)
 
 ```python
 class EOLFixer():
 ```
 
-Converter between Unix and WIndows line endings.
+Converter between Unix and Windows line endings.
 
 ### EOLFixer.add_newline
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/eol_fixer.py#L63)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/eol_fixer.py#L63)
 
 ```python
 @classmethod
@@ -35,7 +35,7 @@ Add newline character to the end if it is missing.
 
 ### EOLFixer.get_line_ending
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/eol_fixer.py#L56)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/eol_fixer.py#L56)
 
 ```python
 @classmethod
@@ -46,7 +46,7 @@ Get line ending character.
 
 ### EOLFixer.is_crlf
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/eol_fixer.py#L14)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/eol_fixer.py#L14)
 
 ```python
 @classmethod
@@ -61,7 +61,7 @@ Arguments:
 
 ### EOLFixer.to_crlf
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/eol_fixer.py#L40)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/eol_fixer.py#L40)
 
 ```python
 @classmethod
@@ -80,7 +80,7 @@ Returns:
 
 ### EOLFixer.to_lf
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/eol_fixer.py#L24)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/eol_fixer.py#L24)
 
 ```python
 @classmethod

diff --git a/docs/newversion/exceptions.md b/docs/newversion/exceptions.md
@@ -1,6 +1,6 @@
 # Exceptions
 
-> Auto-generated documentation for [newversion.exceptions](https://github.com/vemel/newversion//blob/main/newversion/exceptions.py) module.
+> Auto-generated documentation for [newversion.exceptions](https://github.com/vemel/newversion/blob/main/newversion/exceptions.py) module.
 
 - [newversion](../README.md#newversion---your-version-manager) / [Modules](../MODULES.md#newversion-modules) / [Newversion](index.md#newversion) / Exceptions
     - [CLIError](#clierror)
@@ -9,7 +9,7 @@
 
 ## CLIError
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/exceptions.py#L13)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/exceptions.py#L13)
 
 ```python
 class CLIError(Exception):
@@ -19,7 +19,7 @@ Main CLI error
 
 ## ExecutorError
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/exceptions.py#L7)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/exceptions.py#L7)
 
 ```python
 class ExecutorError(Exception):
@@ -29,7 +29,7 @@ Main CLI commands executor error.
 
 ## PackageVersionError
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/exceptions.py#L1)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/exceptions.py#L1)
 
 ```python
 class PackageVersionError(Exception):

diff --git a/docs/newversion/executor.md b/docs/newversion/executor.md
@@ -1,6 +1,6 @@
 # Executor
 
-> Auto-generated documentation for [newversion.executor](https://github.com/vemel/newversion//blob/main/newversion/executor.py) module.
+> Auto-generated documentation for [newversion.executor](https://github.com/vemel/newversion/blob/main/newversion/executor.py) module.
 
 CLI commands executor.
 
@@ -17,7 +17,7 @@ CLI commands executor.
 
 ## Executor
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/executor.py#L15)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/executor.py#L15)
 
 ```python
 class Executor():
@@ -32,7 +32,7 @@ CLI commands executor.
 
 ### Executor().command_bump
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/executor.py#L73)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/executor.py#L76)
 
 ```python
 def command_bump(release: ReleaseNonLocalTypeDef, increment: int) -> Version:
@@ -56,7 +56,7 @@ A new Version.
 
 ### Executor().command_compare
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/executor.py#L149)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/executor.py#L155)
 
 ```python
 def command_compare(command: OperatorTypeDef, other: Version) -> None:
@@ -80,7 +80,7 @@ Processed `Version`.
 
 ### Executor().command_get
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/executor.py#L26)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/executor.py#L26)
 
 ```python
 def command_get(release: ReleaseTypeDef) -> str:
@@ -102,7 +102,7 @@ Part as a string.
 
 ### Executor().command_get_version
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/executor.py#L172)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/executor.py#L178)
 
 ```python
 def command_get_version() -> Version:
@@ -114,7 +114,7 @@ def command_get_version() -> Version:
 
 ### Executor().command_is_stable
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/executor.py#L139)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/executor.py#L145)
 
 ```python
 def command_is_stable() -> None:
@@ -128,7 +128,7 @@ Check whether version is stable.
 
 ### Executor().command_set
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/executor.py#L106)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/executor.py#L112)
 
 ```python
 def command_set(release: ReleaseNonLocalTypeDef, value: int) -> Version:
@@ -152,15 +152,15 @@ A new Version.
 
 ### Executor().command_set_version
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/executor.py#L178)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/executor.py#L184)
 
 ```python
 def command_set_version() -> None:
 ```
 
 ### Executor().command_stable
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/executor.py#L130)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/executor.py#L136)
 
 ```python
 def command_stable() -> Version:

diff --git a/docs/newversion/index.md b/docs/newversion/index.md
@@ -1,6 +1,6 @@
 # Newversion
 
-> Auto-generated documentation for [newversion](https://github.com/vemel/newversion//blob/main/newversion/__init__.py) module.
+> Auto-generated documentation for [newversion](https://github.com/vemel/newversion/blob/main/newversion/__init__.py) module.
 
 - [newversion](../README.md#newversion---your-version-manager) / [Modules](../MODULES.md#newversion-modules) / Newversion
     - Modules

diff --git a/docs/newversion/main.md b/docs/newversion/main.md
@@ -1,6 +1,6 @@
 # Main
 
-> Auto-generated documentation for [newversion.main](https://github.com/vemel/newversion//blob/main/newversion/main.py) module.
+> Auto-generated documentation for [newversion.main](https://github.com/vemel/newversion/blob/main/newversion/main.py) module.
 
 - [newversion](../README.md#newversion---your-version-manager) / [Modules](../MODULES.md#newversion-modules) / [Newversion](index.md#newversion) / Main
     - [main_api](#main_api)
@@ -9,7 +9,7 @@
 
 ## main_api
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/main.py#L24)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/main.py#L24)
 
 ```python
 def main_api(config: argparse.Namespace) -> str:
@@ -19,7 +19,7 @@ Main API entrypoint.
 
 ## main_cli
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/main.py#L55)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/main.py#L55)
 
 ```python
 def main_cli() -> None:
@@ -29,7 +29,7 @@ Main entrypoint for CLI.
 
 ## setup_logging
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/main.py#L11)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/main.py#L11)
 
 ```python
 def setup_logging(level: int) -> logging.Logger:

diff --git a/docs/newversion/module.md b/docs/newversion/module.md
@@ -1,6 +1,6 @@
 # Module
 
-> Auto-generated documentation for [newversion.__main__](https://github.com/vemel/newversion//blob/main/newversion/__main__.py) module.
+> Auto-generated documentation for [newversion.__main__](https://github.com/vemel/newversion/blob/main/newversion/__main__.py) module.
 
 Main entrypoint for module.
 

diff --git a/docs/newversion/package_version.md b/docs/newversion/package_version.md
@@ -1,6 +1,6 @@
 # PackageVersion
 
-> Auto-generated documentation for [newversion.package_version](https://github.com/vemel/newversion//blob/main/newversion/package_version.py) module.
+> Auto-generated documentation for [newversion.package_version](https://github.com/vemel/newversion/blob/main/newversion/package_version.py) module.
 
 - [newversion](../README.md#newversion---your-version-manager) / [Modules](../MODULES.md#newversion-modules) / [Newversion](index.md#newversion) / PackageVersion
     - [PackageVersion](#packageversion)
@@ -9,7 +9,7 @@
 
 ## PackageVersion
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/package_version.py#L13)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/package_version.py#L13)
 
 ```python
 class PackageVersion():
@@ -18,7 +18,7 @@ class PackageVersion():
 
 ### PackageVersion().get
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/package_version.py#L195)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/package_version.py#L195)
 
 ```python
 def get() -> Version:
@@ -30,7 +30,7 @@ def get() -> Version:
 
 ### PackageVersion().set
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/package_version.py#L208)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/package_version.py#L208)
 
 ```python
 def set(version: Version) -> None:

diff --git a/docs/newversion/type_defs.md b/docs/newversion/type_defs.md
@@ -1,5 +1,5 @@
 # Type Defs
 
-> Auto-generated documentation for [newversion.type_defs](https://github.com/vemel/newversion//blob/main/newversion/type_defs.py) module.
+> Auto-generated documentation for [newversion.type_defs](https://github.com/vemel/newversion/blob/main/newversion/type_defs.py) module.
 
 - [newversion](../README.md#newversion---your-version-manager) / [Modules](../MODULES.md#newversion-modules) / [Newversion](index.md#newversion) / Type Defs
diff --git a/docs/newversion/utils.md b/docs/newversion/utils.md
@@ -1,13 +1,13 @@
 # Utils
 
-> Auto-generated documentation for [newversion.utils](https://github.com/vemel/newversion//blob/main/newversion/utils.py) module.
+> Auto-generated documentation for [newversion.utils](https://github.com/vemel/newversion/blob/main/newversion/utils.py) module.
 
 - [newversion](../README.md#newversion---your-version-manager) / [Modules](../MODULES.md#newversion-modules) / [Newversion](index.md#newversion) / Utils
     - [print_path](#print_path)
 
 ## print_path
 
-[[find in source code]](https://github.com/vemel/newversion//blob/main/newversion/utils.py#L4)
+[[find in source code]](https://github.com/vemel/newversion/blob/main/newversion/utils.py#L4)
 
 ```python
 def print_path(path: Path) -> str: