Skip to content

Commit

Permalink
Update links from sourcehut to GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
@harmtemolder
harmtemolder committed Dec 27, 2022
1 parent 7acfa2a commit ca272a8
Showing 2 changed files with 36 additions and 38 deletions.
70 changes: 34 additions & 36 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -24,7 +24,7 @@ Releases will also be uploaded to [this plugin thread on the MobileRead Forums](

#### Alternatively

1. Download the latest release from [here](https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/releases).
1. Download the latest release from [here](https://github.com/harmtemolder/koreader-calibre-plugin/tree/main/releases).
2. Go to your calibre's “Preferences” > “Plugins” > “Load plugin from file” and point it to the downloaded ZIP file
3. Restart calibre

@@ -55,6 +55,7 @@ Releases will also be uploaded to [this plugin thread on the MobileRead Forums](
### Supported devices

This plugin has been tested successfully with:

- Kobo Aura connected over USB, which means it will probably work for all comparable Kobo devices (`KOBO` and `KOBOTOUCH`)
- Kobo Aura H2O over USB (`KOBOTOUCHEXTENDED`, see [#6](https://todo.sr.ht/~harmtemolder/koreader-calibre-plugin/6) for details)
- Kobo Aura connected wirelessly, which means it will probably work for all calibre connect devices (`SMART_DEVICE_APP`)
@@ -65,11 +66,12 @@ This plugin has been tested successfully with:
- PocketBooks that use the `POCKETBOOK622` driver

This plugin is not compatible with:

- `MTP_DEVICE` (see [#2](https://todo.sr.ht/~harmtemolder/koreader-calibre-plugin/2) for details)

### Issues

If you encounter any issues with the plugin, please submit them [here](https://todo.sr.ht/~harmtemolder/koreader-calibre-plugin).
If you encounter any issues with the plugin, please submit them [here](https://github.com/harmtemolder/koreader-calibre-plugin/issues).

## Acknowledgements

@@ -84,8 +86,8 @@ If you encounter any issues with the plugin, please submit them [here](https://t
- My first attempt was actually to sync calibre with KOReader's read progress through the progress sync plugin and a [sync server](https://github.com/koreader/koreader-sync-server). Read [here](https://github.com/koreader/koreader/issues/6399#issuecomment-721826362) why that did not work. This plugin might actually make that possible now by allowing you to store KOReader's MD5 hash in calibre...
- calibre allows you to auto-connect to a folder device on boot, which greatly speeds up your workflow when testing. You can find this under “Preferences” > “Tweaks”, search for `auto_connect_to_folder`. Point that to the `dummy_device` folder in this repository. (I have included royalty free EPUBs for your and my convenience.)
- If you're testing and don't actually want to update any metadata, set `DRY_RUN` to `True` in `__init__.py`.
- I work in PyCharm, which offers a remote debugging server. Follow [these steps](https://harmtemolder.com/calibre-development-in-pycharm/) to set that up. To enable that in this plugin, set `PYDEVD` to `True` in `__init__.py`.You might need to change `sys.path.append` in `action.py`.
- The supported device drivers can be found in [the `supported_devices` list at line 366 in `action.py`](https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/action.py#L366). Adding a new type here is the first step to adding support, but make sure all features are tested thoroughly before releasing a version with an added device
- I work in PyCharm, which offers a remote debugging server. To enable that in this plugin, set `PYDEVD` to `True` in `__init__.py`.You might need to change `sys.path.append` in `action.py`.
- The supported device drivers can be found in [the `supported_devices` list at line 387 in `action.py`](https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/action.py#L387). Adding a new type here is the first step to adding support, but make sure all features are tested thoroughly before releasing a version with an added device

### Downloading dependencies

@@ -117,19 +119,15 @@ make zip

### Debugging a release

1. Download the required release from [here](https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases)
2. Add it to calibre by running this in your terminal: `calibre-customize -a "KOReader Sync vX.X.X-alpha.zip"`, where `X.X.X` refers to the version you downloaded
3. Start calibre in debug mode with `calibre-debug -g`
4. Configure the KOReader plugin as described [here](https://git.sr.ht/~harmtemolder/koreader-calibre-plugin#setup)
5. Connect your device
6. Run the sync by clicking the KOReader icon in your toolbar
7. Check the details of the message when it's done if any/all books have been synced correctly
7. Check your (custom) columns for one of those books to see if their contents are what they should be
7. Check the output in your terminal for lines containing `koreader` to see what it did

### Sending in your patches

Contributing patches on sourcehut works through `git send-email`. You can find this repository's mailing list [here](https://lists.sr.ht/~harmtemolder/koreader-calibre-plugin).
1. Download the required release from [here](https://github.com/harmtemolder/koreader-calibre-plugin/tree/main/releases)
1. Add it to calibre by running this in your terminal: `calibre-customize -a "KOReader Sync vX.X.X-alpha.zip"`, where `X.X.X` refers to the version you downloaded
1. Start calibre in debug mode with `calibre-debug -g`
1. Configure the KOReader plugin as described [here](https://github.com/harmtemolder/koreader-calibre-plugin#setup)
1. Connect your device
1. Run the sync by clicking the KOReader icon in your toolbar
1. Check the details of the message when it's done if any/all books have been synced correctly
1. Check your (custom) columns for one of those books to see if their contents are what they should be
1. Check the output in your terminal for lines containing `koreader` to see what it did

## Changelog

@@ -268,22 +266,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- `environment.yml`, in case anyone wants to recreate my Conda environment
- This `README.md`

[0.1.0-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.1.0-alpha.zip
[0.1.1-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.1.1-alpha.zip
[0.1.2-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.1.2-alpha.zip
[0.1.3-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.1.3-alpha.zip
[0.1.4-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.1.4-alpha.zip
[0.2.0-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.2.0-alpha.zip
[0.2.1-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.2.1-alpha.zip
[0.2.2-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.2.2-alpha.zip
[0.2.3-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.2.3-alpha.zip
[0.2.4-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.2.4-alpha.zip
[0.2.5-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.2.5-alpha.zip
[0.2.6-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.2.6-alpha.zip
[0.2.7-alpha]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.2.7-alpha.zip
[0.3.0-beta]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.3.0-beta.zip
[0.3.1-beta]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.3.1-beta.zip
[0.3.2-beta]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.3.2-beta.zip
[0.4.0-beta]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.4.0-beta.zip
[0.4.1-beta]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree/main/item/releases/KOReader%20Sync%20v0.4.1-beta.zip
[unreleased]: https://git.sr.ht/~harmtemolder/koreader-calibre-plugin/tree
[0.1.0-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.1.0-alpha.zip
[0.1.1-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.1.1-alpha.zip
[0.1.2-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.1.2-alpha.zip
[0.1.3-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.1.3-alpha.zip
[0.1.4-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.1.4-alpha.zip
[0.2.0-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.2.0-alpha.zip
[0.2.1-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.2.1-alpha.zip
[0.2.2-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.2.2-alpha.zip
[0.2.3-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.2.3-alpha.zip
[0.2.4-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.2.4-alpha.zip
[0.2.5-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.2.5-alpha.zip
[0.2.6-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.2.6-alpha.zip
[0.2.7-alpha]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.2.7-alpha.zip
[0.3.0-beta]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.3.0-beta.zip
[0.3.1-beta]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.3.1-beta.zip
[0.3.2-beta]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.3.2-beta.zip
[0.4.0-beta]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.4.0-beta.zip
[0.4.1-beta]: https://github.com/harmtemolder/koreader-calibre-plugin/blob/main/releases/KOReader%20Sync%20v0.4.1-beta.zip
[unreleased]: https://github.com/harmtemolder/koreader-calibre-plugin
4 changes: 2 additions & 2 deletions about.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h2>About KOReader Sync</h2>
<p>A calibre plugin to synchronize metadata from KOReader to calibre.</p>
<p>The source code of this plugin can be found <a href="https://git.sr.ht/~harmtemolder/koreader-calibre-plugin">on sourcehut</a>.</p>
<p>If you encounter any issues with the plugin, please submit them <a href="https://todo.sr.ht/~harmtemolder/koreader-calibre-plugin">here</a>.</p>
<p>The source code of this plugin can be found <a href="https://github.com/harmtemolder/koreader-calibre-plugin">on GitHub</a>.</p>
<p>If you encounter any issues with the plugin, please submit them <a href="https://github.com/harmtemolder/koreader-calibre-plugin/issues">here</a>.</p>

0 comments on commit ca272a8

Please sign in to comment.