update docs

CHANGELOG.md

@@ -1,17 +1,23 @@
 # Changelog
 
-## WIP
+## v3.0.0a0 (2023-12-31)
 
-- New action: `write`.
+- New action: `write` to write lines into a file.
 - New filter: `date_lastused` (macOS only).
 - You can now specify the timezone in all time based filters.
 - Removed hidden (deprecated) CLI option `--config-file`.
 - Lots of new tests and some bugfixes.
 - `exif` filter now supports the simplematch syntax.
-- {now} must be {now()} now.
-- multiple paths per location
-- min_depth option
-- last_seen
+- Placeholder`{now}` must be `{now()}` now.
+- Multiple `path`s per location are now supported.
+- Locations now support a `min_depth` option
+- Duplicate filter: `detect_original_by` now supports `last_seen`.
+- New command line interface (added `new`, `show` and `list` commands).
+- `JSONL` output (`organize run --format=JSONL`)
+- `move` and `copy` now intelligently autodetect if you mean to move to a folder
+  (This autodetection can be deactivated).
+- `copy` action: You can now specify whether you want to continue with the original
+  or with the copy.
 
 ## v2.4.3 (2023-10-14)
 

README.md

@@ -26,11 +26,24 @@
 <a href="https://organize.readthedocs.io/" target="_blank">Full documentation at Read the docs</a>
 </p>
 
-## **organize v2 is released!**
 
-- [See the changelog](https://organize.readthedocs.io/en/latest/changelog/#v200-2022-02-07) for all the new
-  features!
-- [Migration guide](https://organize.readthedocs.io/en/latest/updating-from-v1/) from organize v1
+## Testers needed! Help testing the v3-alpha
+
+A prerelease of organize v3 is available. To install:
+
+```sh
+# Installs the pre release!
+pip install -U organize-tool --pre
+
+# Installs the pre release with text extraction utils.
+pip install -U organize-tool[textract] --pre
+```
+
+The new version should be *much* faster and fixes a lot of bugs. It also comes with
+a some new actions, filters and options.
+
+- [See the changelog](https://tfeldmann.github.io/organize/changelog/)
+- [Migration guide](https://tfeldmann.github.io/organize/migrating/#migrating-from-v2-to-v3).
 
 ## About
 
@@ -79,7 +92,7 @@ This command can also be used to update to the newest version. Now you can run `
 
 ### Create your first rule
 
-In your shell, run `organize edit` to edit the configuration:
+In your shell, run `organize new` and then `organize edit` to edit the configuration:
 
 ```yaml
 rules:
@@ -93,7 +106,7 @@ rules:
       - echo: "Found PDF!"
 ```
 
-> If you have problems editing the configuration you can run `organize reveal` to reveal the configuration folder in your file manager. You can then edit the `config.yaml` in your favourite editor.
+> If you have problems editing the configuration you can run `organize show --reveal` to reveal the configuration folder in your file manager. You can then edit the `config.yaml` in your favourite editor.
 
 save your config file and run:
 

docs/migrating.md

@@ -10,15 +10,22 @@ Please open a issue on Github if you need help migrating your config file!
 
 <hr>
 
-## Coming from organize v2
+## Migrating from v2 to v3
 
 ### Locations
 
 In organize v3 remote filesystems are no longer supported. You have to remove all
 `filesystem` parameters from your config and cannot longer use pyfilesystem URLs
 your `location`.
 
+### Placeholders
+
+- Use `{now()}` instead of `{now}`.
+- Use `{utcnow()}` instead of `{utcnow}`.
+- The placeholders `{fs}` and `{fs_path}` are no longer available.
+
 ### Command line interface
+
 The command line interface changed quite a bit! Update any scripts using the CLI
 to the new options:
 
@@ -28,9 +35,13 @@ to the new options:
 - `organize schema` is not longer supported.
 - The already deprecated `--config-file` option is now removed.
 
+
+That's it. If you encounter any other bugs or problems during the migration, please
+reach out!
+
 <hr>
 
-## Coming from organize v1
+## Migrating from v1 to v2
 
 
 ### Folders

docs/rules.md

@@ -79,20 +79,14 @@ The full path to the current file / folder on the local harddrive.
 This is not available for remote locations - in this case use `fs` and `fs_path`.
 
 `{relative_path}` (`str`)<br>
-the relative path of the current file in `{fs}`.
+the relative path of the current file or dir.
 
 `{now}` (`datetime`)<br>
 The current datetime in the local timezone.
 
 `{utcnow}` (`datetime`)<br>
 The current UTC datetime.
 
-`{fs}` (`FS`)<br>
-The filesystem of the current location. Normally you should not need this.
-
-`{fs_path}` (`str`)<br>
-The path of the current file / folder in related to `fs`. Normally you should not need this.
-
 In addition to that nearly all filters add new placeholders with information about
 the currently handled file / folder.
 

organize/cli.py

@@ -108,7 +108,7 @@ def new(config: Optional[str]) -> None:
         config_path = find_config(config)
         console.print(
             f'Config "{config_path}" already exists.\n'
-            'Use "organize new \[name]" to create a config in the default location.'
+            r'Use "organize new \[name]" to create a config in the default location.'
         )
     except ConfigNotFound as e:
         assert e.init_path is not None