|
| 1 | +# Change Log |
| 2 | +All notable changes to this project will be documented in this file. |
| 3 | + |
| 4 | +The format is based on [Keep a Changelog](http://keepachangelog.com/) |
| 5 | +and this project adheres to [Semantic Versioning](http://semver.org/). |
| 6 | + |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | + |
| 11 | +## [1.3.0] - 2026-02-19 |
| 12 | +Fixes interoperability with Zotero v8 + BetterBibtex, but not backward |
| 13 | +compatible. |
| 14 | +### Changed |
| 15 | +- Update queries for the new Zotero SQLite DB format for citation keys. |
| 16 | +- Move Better Bibtex mapping to use the new Zotero SQLite citation key table. |
| 17 | + |
| 18 | + |
| 19 | +## [1.2.0] - 2026-01-04 |
| 20 | +### Changed |
| 21 | +- Switch build tools to [pixi]. |
| 22 | +- Add support for Python 3.13. |
| 23 | +- Upgrade [zensols.dbutil] to 1.5.0. |
| 24 | + |
| 25 | + |
| 26 | +## [1.1.0] - 2025-01-11 |
| 27 | +### Removed |
| 28 | +- Support for Python 3.10. |
| 29 | + |
| 30 | +### Changed |
| 31 | +- Upgraded to [zensols.util] version 1.15. |
| 32 | + |
| 33 | + |
| 34 | +## [1.0.0] - 2024-09-22 |
| 35 | +Somewhat minor feature release to add BetterBibtex citation and item attachment |
| 36 | +(paper) lookup. |
| 37 | + |
| 38 | +### Changed |
| 39 | +- Refactored the database (`zensols.zotsite.db`) module by separating SQL into |
| 40 | + resource file and use connection pooling with the [zensols.dbutil] package. |
| 41 | + |
| 42 | +### Removed |
| 43 | +- The command line render (`show` option) to render the website after export. |
| 44 | + |
| 45 | +### Added |
| 46 | +- BetterBibtex citation key output with the `lookup` command line action. |
| 47 | +- Integration tests with mock Zotero database. Now all tests are self |
| 48 | + contained. |
| 49 | +- An API and command line to give attachment (paper document) paths based on an |
| 50 | + item key. This can be combined with the item ID to citation ID mapping if |
| 51 | + starting with a BetterBibtex citation ID. |
| 52 | +- An example of using finding and displaying papers using the new API. |
| 53 | + |
| 54 | + |
| 55 | +## [0.9.1] - 2024-01-02 |
| 56 | +### Changed |
| 57 | +- BetterBibtex version 6.7.140: retrieve citations keys from the `citationkey` |
| 58 | + table rather than the JSON blob in the `better-bibtex` table. This change |
| 59 | + fixes new entries using the BetterBibtex citation keys for some users and |
| 60 | + fixes runtime errors for others. |
| 61 | + |
| 62 | + |
| 63 | +## [0.9.0] - 2023-12-05 |
| 64 | +### Changed |
| 65 | +- Upgrade to [zensols.util] version 1.14. |
| 66 | + |
| 67 | +### Added |
| 68 | +- Support for Python 3.11. |
| 69 | + |
| 70 | +### Removed |
| 71 | +- Support for Python 3.9. |
| 72 | + |
| 73 | + |
| 74 | +## [0.8.2] - 2023-10-25 |
| 75 | +### Changed |
| 76 | +- [Fixed SQLite access](https://github.com/plandes/zotsite/pull/29) to cite |
| 77 | + keys, by [Emiliano Heyns](https://github.com/retorquere), after better-bibtex |
| 78 | + upgrade. |
| 79 | +- Added icon mapping for `preprint` and `dataset`. |
| 80 | + |
| 81 | + |
| 82 | +## [0.8.1] - 2023-08-23 |
| 83 | +### Changed |
| 84 | +- Add an configuration option to robustly handle errors generated by the |
| 85 | + operating system on file system access (perhaps from a corrupted database. |
| 86 | + |
| 87 | + |
| 88 | +## [0.8.0] - 2023-08-16 |
| 89 | +Downstream moderate risk update release. |
| 90 | + |
| 91 | +### Changed |
| 92 | +- Upgrade to [zensols.util] v1.13.0. |
| 93 | + |
| 94 | + |
| 95 | +## [0.7.0] - 2023-01-22 |
| 96 | +### Changed |
| 97 | +- Upgrade to [zensols.util] v1.12.0. |
| 98 | + |
| 99 | + |
| 100 | +## [0.6.3] - 2022-11-21 |
| 101 | +### Changed |
| 102 | +- Default tilde home directory as Windows uses other environment variables. |
| 103 | + Python's `pathlib` appears to be able to find them per [issue 20]. |
| 104 | + |
| 105 | +- Updated documentation. |
| 106 | + |
| 107 | + |
| 108 | +## [0.6.2] - 2022-10-30 |
| 109 | +### Changed |
| 110 | +- Another bug fix to [DataTables] initialization. |
| 111 | + |
| 112 | + |
| 113 | +## [0.6.1] - 2022-10-29 |
| 114 | +### Changed |
| 115 | +- Bug fix to [DataTables] initialization. |
| 116 | + |
| 117 | + |
| 118 | +## [0.6.0] - 2022-10-29 |
| 119 | +### Added |
| 120 | +- Added a collections table of all the child items/papers. This involves |
| 121 | + adding [DataTables] as a dependency. |
| 122 | +- Optionally view the created export in a browser using [zensols.showfile]. |
| 123 | + |
| 124 | +### Changes |
| 125 | +- Storage (paper PDF files) keep time stamps to speed up rsync. |
| 126 | +- Upgraded to Bootstrap 4.6.2. |
| 127 | + |
| 128 | + |
| 129 | +## [0.5.0] - 2022-10-28 |
| 130 | +### Changes |
| 131 | +- Sort nodes by item name in the left tree navigation (thanks to |
| 132 | + [Cai-98](https://github.com/Cai-98)). |
| 133 | +- Upgrade to [zensols.util] 1.11. |
| 134 | +- Separate database filtering using `where` clauses and regular expression |
| 135 | + pattern filtering. |
| 136 | + |
| 137 | +### Added |
| 138 | +- Support for Python 3.9, 3.10. |
| 139 | + |
| 140 | +### Removed |
| 141 | +- Support for Python 3.7, 3.8. |
| 142 | + |
| 143 | + |
| 144 | +## [0.4.0] - 2022-08-08 |
| 145 | +### Added |
| 146 | +- Add URL parameter to go directly to the PDF. |
| 147 | + |
| 148 | +### Changed |
| 149 | +- Fix `zensols.util` dependency for Python 3.7 and 3.8 comparability. |
| 150 | + |
| 151 | + |
| 152 | +## [0.3.6] - 2021-03-23 |
| 153 | +### Changed |
| 154 | +- Add pattern support for attachment prefix in items. It appears that it acts |
| 155 | + like `storage` used to point to a file in the storage path. See issue |
| 156 | + [#18](https://github.com/plandes/zotsite/issues/18). |
| 157 | + |
| 158 | + |
| 159 | +## [0.3.5] - 2021-03-16 |
| 160 | +### Changed |
| 161 | +- Switch from travis to github workflows. |
| 162 | +- Upgrade to [zensols.util] 1.4.1. |
| 163 | + |
| 164 | + |
| 165 | +## [0.3.4] - 2020-12-09 |
| 166 | +### Added |
| 167 | +- Sphinx documentation, which includes API docs. |
| 168 | +### Changed |
| 169 | +- Upgrade to [zensols.util] 1.3.0. |
| 170 | + |
| 171 | + |
| 172 | +## [0.3.3] - 2020-04-25 |
| 173 | +### Changed |
| 174 | +- Upgrade to [zensols.util] 1.2.0. |
| 175 | + |
| 176 | +### Removed |
| 177 | +- Drop support for Python 3.6. |
| 178 | + |
| 179 | +### Added |
| 180 | +- Added icons for thesis, patents and blog posts. |
| 181 | +- Added option to sort items in the tree navigation. |
| 182 | + |
| 183 | + |
| 184 | +## [0.3.2] - 2020-01-03 |
| 185 | +### Added |
| 186 | +- Compatibility with [ZotFile]. Specifically, now storage locations are used |
| 187 | + verbatim if 1) no `storage:` is found in the resource name and 2) if the |
| 188 | + resource is a file found on the OS. |
| 189 | + |
| 190 | + |
| 191 | +## [0.3.1] - 2019-12-24 |
| 192 | +### Changed |
| 193 | +- Fixed export error: `No such file or directory: 'resources/src'`. |
| 194 | + |
| 195 | + |
| 196 | +## [0.3.0] - 2019-12-20 |
| 197 | +### Added |
| 198 | +- Collections filtering using regular expressions is now fully supported. |
| 199 | +- Ability to link directly to any item in the hierarchy. |
| 200 | +- Link button that copies the current page URL to the clipboard. |
| 201 | +- Added [BetterBibtex] references for easy linking to the site with citation |
| 202 | + keys. |
| 203 | +- HTML (i.e. snapshots) are now visible in the pane PDFs are displayed. |
| 204 | +- Short files to reduce character/file system conflicts. |
| 205 | +- Clear button to reset the interface. |
| 206 | +- Added creators (authors) to metadata pane. |
| 207 | + |
| 208 | +### Changed |
| 209 | +- Beautification of the metadata keys in the item table view. |
| 210 | +- Changed default naming to use short files. |
| 211 | +- Simpler command line by moving configuration to the configuration file. |
| 212 | +- Refactored: cleaned up class structure and graph iteration OO class patterns. |
| 213 | +- Retrofit new actioncli features. |
| 214 | +- Move to more advanced configparser, which uses new notation (example: |
| 215 | + `$(HOME)s` -> `${HOME}`). |
| 216 | +- Metadata is sorted. |
| 217 | + |
| 218 | + |
| 219 | +## [0.2.3] - 2018-09-08 |
| 220 | +### Added |
| 221 | +- Feature to export collections based on an regular expression match on name. |
| 222 | + |
| 223 | +### Changes |
| 224 | +- Notes now have full note text with Zotero CSS, so it looks as it does in the |
| 225 | + desktop app. Note titles have the text from the note title instead of just |
| 226 | + `Note`. |
| 227 | + |
| 228 | + |
| 229 | +## [0.2.2] - 2018-08-31 |
| 230 | +### Added |
| 231 | +- Get version from pkg resources. |
| 232 | + |
| 233 | + |
| 234 | +## [0.2.1] - 2018-08-11 |
| 235 | +### Changed |
| 236 | +- Fixed pip wheel dependency auto install. |
| 237 | +- New python build. |
| 238 | + |
| 239 | + |
| 240 | +## [0.2.0] - 2018-08-10 |
| 241 | +### Added |
| 242 | +- More icons for more resource types |
| 243 | +- Added example site. |
| 244 | + |
| 245 | +### Changed |
| 246 | +- Fix new item type for which there is no icon. |
| 247 | +- Fix include trash doc. |
| 248 | +- Move to three dimension version numbering |
| 249 | + |
| 250 | + |
| 251 | +## [0.0.1] - 2018-03-07 |
| 252 | +### Added |
| 253 | +- Initial version |
| 254 | + |
| 255 | + |
| 256 | +[Unreleased]: https://github.com/plandes/zotsite/compare/v1.3.0...HEAD |
| 257 | +[1.3.0]: https://github.com/plandes/zotsite/compare/v1.2.0...v1.3.0 |
| 258 | +[1.2.0]: https://github.com/plandes/zotsite/compare/v1.1.0...v1.2.0 |
| 259 | +[1.1.0]: https://github.com/plandes/zotsite/compare/v1.0.0...v1.1.0 |
| 260 | +[1.0.0]: https://github.com/plandes/zotsite/compare/v0.9.1...v1.0.0 |
| 261 | +[0.9.1]: https://github.com/plandes/zotsite/compare/v0.9.0...v0.9.1 |
| 262 | +[0.9.0]: https://github.com/plandes/zotsite/compare/v0.8.2...v0.9.0 |
| 263 | +[0.8.2]: https://github.com/plandes/zotsite/compare/v0.8.1...v0.8.2 |
| 264 | +[0.8.1]: https://github.com/plandes/zotsite/compare/v0.8.0...v0.8.1 |
| 265 | +[0.8.0]: https://github.com/plandes/zotsite/compare/v0.7.0...v0.8.0 |
| 266 | +[0.7.0]: https://github.com/plandes/zotsite/compare/v0.6.3...v0.7.0 |
| 267 | +[0.6.3]: https://github.com/plandes/zotsite/compare/v0.6.2...v0.6.3 |
| 268 | +[0.6.2]: https://github.com/plandes/zotsite/compare/v0.6.1...v0.6.2 |
| 269 | +[0.6.1]: https://github.com/plandes/zotsite/compare/v0.6.0...v0.6.1 |
| 270 | +[0.6.0]: https://github.com/plandes/zotsite/compare/v0.5.0...v0.6.0 |
| 271 | +[0.5.0]: https://github.com/plandes/zotsite/compare/v0.4.0...v0.5.0 |
| 272 | +[0.4.0]: https://github.com/plandes/zotsite/compare/v0.3.6...v0.4.0 |
| 273 | +[0.3.6]: https://github.com/plandes/zotsite/compare/v0.3.5...v0.3.6 |
| 274 | +[0.3.5]: https://github.com/plandes/zotsite/compare/v0.3.4...v0.3.5 |
| 275 | +[0.3.4]: https://github.com/plandes/zotsite/compare/v0.3.3...v0.3.4 |
| 276 | +[0.3.3]: https://github.com/plandes/zotsite/compare/v0.3.2...v0.3.3 |
| 277 | +[0.3.2]: https://github.com/plandes/zotsite/compare/v0.3.1...v0.3.2 |
| 278 | +[0.3.1]: https://github.com/plandes/zotsite/compare/v0.3.0...v0.3.1 |
| 279 | +[0.3.0]: https://github.com/plandes/zotsite/compare/v0.2.3...v0.3.0 |
| 280 | +[0.2.3]: https://github.com/plandes/zotsite/compare/v0.2.2...v0.2.3 |
| 281 | +[0.2.2]: https://github.com/plandes/zotsite/compare/v0.2.1...v0.2.2 |
| 282 | +[0.2.1]: https://github.com/plandes/zotsite/compare/v0.2.0...v0.2.1 |
| 283 | +[0.2.0]: https://github.com/plandes/zotsite/compare/v0.1...v0.2.0 |
| 284 | + |
| 285 | +<!-- links --> |
| 286 | +[BetterBibtex]: https://github.com/retorquere/zotero-better-bibtex |
| 287 | +[ZotFile]: http://zotfile.com |
| 288 | +[zensols.util]: https://github.com/plandes/util |
| 289 | +[zensols.showfile]: https://github.com/plandes/rend |
| 290 | +[zensols.dbutil]: https://github.com/plandes/dbutil |
| 291 | +[DataTables]: https://datatables.net |
| 292 | +[issue 20]: https://github.com/plandes/zotsite/issues/20#issuecomment-1321320667 |
| 293 | +[pixi]: https://pixi.sh |
0 commit comments