Set init --base flag by defaault (#1240)

Author: droserasprout

CHANGELOG.md

@@ -8,10 +8,19 @@ Releases prior to 7.0 has been removed from this file to declutter search result
 
 ## [Unreleased]
 
-### Fidex
+### Added
+
+- cli: Added `init --no-base` option to skip creating the base template.
+- env: Added `DIPDUP_NO_BASE` environment variable to skip creating the base template.
+
+### Fixed
 
 - cli: Fixed `new` command using incorrect template.
 
+### Changed
+
+- cli: `init --base` option is now enabled by default.
+
 ## [8.3.1] - 2025-04-08
 
 ### Added

Makefile

@@ -87,7 +87,7 @@ demos:          ## Recreate demo projects from templates
 	DIPDUP_NO_SYMLINK=1 python scripts/demos.py init ${DEMO}
 
 demos_refresh:
-	for demo in `ls src | grep demo | grep -v etherlink`; do cd src/$$demo && DIPDUP_NO_SYMLINK=1 dipdup init -b -f && cd ../..; done
+	for demo in `ls src | grep demo | grep -v etherlink`; do cd src/$$demo && DIPDUP_NO_SYMLINK=1 dipdup init --force && cd ../..; done
 
 before_release: ## Prepare for a new release after updating version in pyproject.toml
 	make format lint update demos test docs

docs/1.getting-started/1.installation.md

@@ -36,7 +36,7 @@ make install
 source .venv/bin/activate
 ```
 
-If you prefer to use other package manager, edit `configs/replay.yaml` file and run `dipdup init -b -f`.
+If you prefer to use other package manager, edit `configs/replay.yaml` file and run `dipdup init --force`.
 
 ## Docker
 

docs/1.getting-started/4.package.md

@@ -39,7 +39,7 @@ When upgrading to a newer version of DipDup, particularly major releases, you ma
 To refresh your project package, run:
 
 ```shell [Terminal]
-dipdup init -b -f
+dipdup init --force
 make install
 ```
 

docs/12.faq.md

@@ -178,7 +178,7 @@ For historical reasons, Python package management is a mess. There are multiple
 
 Using PDM/Poetry is not required to run DipDup, but strongly recommended. Choosing one over the other is a matter of personal preference. _As of writing_, Poetry is [faster](https://lincolnloop.github.io/python-package-manager-shootout/), more popular, and has a nicer CLI, while PDM is more PEP-compatible and allows dependency overrides.
 
-You can choose the preferred tool (or none) when initializing a project with `dipdup new` command. If you change your mind later, modify the `replay.yaml` file and run `dipdup init --base --force`.
+You can choose the preferred tool (or none) when initializing a project with `dipdup new` command. If you change your mind later, modify the `replay.yaml` file and run `dipdup init --force`.
 
 ## Miscellaneous
 

docs/5.advanced/2.environment-variables.md

@@ -19,6 +19,8 @@ DipDup uses multiple environment variables internally. They read once on process
 | `DIPDUP_MIGRATIONS`       | Enable migrations with `aerich`                                                      |
 | `DIPDUP_NEXT`             | Enable experimental features from the next major release that require schema changes |
 | `DIPDUP_NO_SYMLINK`       | Don't create magic symlink in the package root even when used as cwd                 |
+| `DIPDUP_NO_LINTER`        | Don't format and lint generated files with ruff                                      |
+| `DIPDUP_NO_BASE`          | Don't generate project template base                                                 |
 | `DIPDUP_NO_VERSION_CHECK` | Disable warning about running unstable or out-of-date DipDup version                 |
 | `DIPDUP_PACKAGE_PATH`     | Disable package discovery and use the specified path                                 |
 | `DIPDUP_REPLAY_PATH`      | Path to datasource replay files; used in tests (dev only)                            |

docs/7.references/1.cli.md

@@ -190,7 +190,13 @@ Discord:               <a class="reference external" href="https://discord.gg/aG
 <dl class="std option">
 <dt class="sig sig-object std" id="cmdoption-dipdup-init-b">
 <span id="cmdoption-dipdup-init-base"></span><span class="sig-name descname"><span class="pre">-b</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--base</span></span><span class="sig-prename descclassname"></span></dt>
-<dd><p>Include template base: pyproject.toml, Dockerfile, etc.</p>
+<dd><p>Include template base (default)</p>
+</dd></dl>
+
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-dipdup-init-0">
+<span id="cmdoption-dipdup-init-no-base"></span><span class="sig-name descname"><span class="pre">-b</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no-base</span></span><span class="sig-prename descclassname"></span></dt>
+<dd><p>Skip template base</p>
 </dd></dl>
 
 <dl class="std option">

docs/9.release-notes/1.v8.3.md

@@ -32,7 +32,7 @@ In this release, we've enhanced the integration:
 - Default project templates are configured to use `uv` by default
 - Better handling of dependencies and virtual environments
 
-To switch to uv in existing projects, update your `configs/replay.yaml` and run `dipdup init -b -f`.
+To switch to uv in existing projects, update your `configs/replay.yaml` and run `dipdup init --force`.
 
 ::banner{type="warning"}
 Note that `uv` build backend (see [#3957](https://github.com/astral-sh/uv/issues/3957), available separately as `uv_build` package) doesn't support non-standard layout of DipDup packages. Hatchling build backend handles both editable and non-editable builds correctly.
@@ -56,7 +56,7 @@ Existing projects will continue to work with 8.3 without any modifications.
 If you want to use recent improvements like the MCP server, uv package manager, and Ruff formatter, refresh your project template:
 
 ```shell [Terminal]
-dipdup init -b -f
+dipdup init --force
 make install
 ```
 

docs/9.release-notes/_8.0_changelog.md

@@ -6,13 +6,15 @@
 - cli: Added `--pre` flag to `self` group commands to install pre-release versions.
 - cli: Added `--raw` option to `config export` command to dump config preserving the original structure.
 - cli: Added `-C` option, a shorthand for `-c . -c configs/dipdup.<name>.yaml`.
+- cli: Added `init --no-base` option to skip creating the base template.
 - cli: Added `package verify` command to check the package consistency.
 - cli: Added full project migration support for 3.0 spec.
 - cli: Added spec_version 3.0 support to `migrate` command.
 - config: Publish JSON schemas for config validation and autocompletion.
 - database: Added `dipdup_status` view to the schema.
 - env: Added `DIPDUP_JSON_LOG` environment variable to enable JSON logging.
 - env: Added `DIPDUP_LOW_MEMORY` variable to reduce the size of caches and buffers.
+- env: Added `DIPDUP_NO_BASE` environment variable to skip creating the base template.
 - env: Added `DIPDUP_PACKAGE_PATH` environment variable to override discovered package path.
 - package: Added built-in `batch` handler to modify higher-level indexing logic.
 - starknet.events: Added `starknet.events` index kind to process Starknet events.
@@ -25,6 +27,7 @@
 - cli: Don't save reports for successful test runs.
 - cli: Don't update existing installation in `self install` command unless asked to.
 - cli: Fixed `--pre` installer flag.
+- cli: Fixed `new` command using incorrect template.
 - cli: Fixed env files not being loaded in some commands.
 - cli: Fixed errors raised when the project package is invalid.
 - cli: Fixed progress estimation when there are indexes with `last_level` option set.
@@ -54,6 +57,7 @@
 ### Changed
 
 - api: `/performance` endpoint response format has been changed.
+- cli: `init --base` option is now enabled by default.
 - config: Index configs accept `datasources` list instead of `datasource` field.
 - config: Index kinds have been renamed and grouped by the network.
 - config: Index template values now can be any JSON-serializable object.

src/dipdup/cli.py

@@ -180,6 +180,9 @@ def wrapper(ctx: click.Context, *args: Any, **kwargs: Any) -> None:
         except (KeyboardInterrupt, asyncio.CancelledError):
             pass
         except Exception as e:
+            if isinstance(e, click.UsageError):
+                raise
+
             from dipdup.report import save_report
 
             package = ctx.obj.config.package if ctx.obj else 'unknown'
@@ -347,7 +350,8 @@ async def run(ctx: click.Context) -> None:
 
 @cli.command()
 @click.option('--force', '-f', is_flag=True, help='Overwrite existing types and ABIs.')
-@click.option('--base', '-b', is_flag=True, help='Include template base: pyproject.toml, Dockerfile, etc.')
+@click.option('--base', '-b', is_flag=True, help='Include template base (default)')
+@click.option('--no-base', '-b', is_flag=True, help='Skip template base')
 @click.option('--no-linter', is_flag=True, help='Skip linter and formatter.')
 @click.argument(
     'include',
@@ -361,6 +365,7 @@ async def init(
     ctx: click.Context,
     force: bool,
     base: bool,
+    no_base: bool,
     no_linter: bool,
     include: list[str],
 ) -> None:
@@ -370,12 +375,17 @@ async def init(
     """
     from dipdup.dipdup import DipDup
 
+    if base:
+        if no_base:
+            raise click.BadParameter('You cannot use both `--base` and `--no-base` options at the same time')
+        _logger.warning('`--base` option became default; use `--no-base` to disable it')
+
     config: DipDupConfig = ctx.obj.config
     dipdup = DipDup(config)
 
     await dipdup.init(
         force=force,
-        base=base or bool(include),
+        no_base=no_base or bool(include),
         no_linter=no_linter,
         include=set(include),
     )
@@ -416,9 +426,10 @@ async def migrate(ctx: click.Context, dry_run: bool) -> None:
     )
     await _cli_unwrapper(init)(
         ctx=ctx,
-        base=True,
+        base=False,
         force=True,
         no_linter=True,
+        no_base=False,
         include=[],
     )
 
@@ -993,6 +1004,7 @@ async def new(
         base=False,
         force=force,
         no_linter=False,
+        no_base=False,
         include=[],
     )