tweetnook 0.0.9__tar.gz

tweetnook-0.0.9/.gitignore

@@ -0,0 +1,29 @@
+# Local data / outputs (never commit)
+data/
+.DS_Store
+
+# Third-party snapshots are tracked but treated as read-only.
+# Ignore untracked files under reference/ (build artifacts, caches, etc.).
+reference/
+
+# Credentials / sessions (never commit)
+twitter_session.json
+tweetnook_session.json
+# Keep legacy session files protected after the application rename.
+tweetxvault_session.json
+*.sqlite
+*.sqlite-wal
+*.sqlite-shm
+*.db
+
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage

tweetnook-0.0.9/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tweetnook-0.0.9/PKG-INFO

@@ -0,0 +1,276 @@
+Metadata-Version: 2.5
+Name: tweetnook
+Version: 0.0.9
+Summary: Self-hosted Web archive for Twitter/X bookmarks, likes, tweets, and official exports.
+Project-URL: Homepage, https://github.com/gezerwezer/tweetnook
+Project-URL: Repository, https://github.com/gezerwezer/tweetnook
+Project-URL: Issues, https://github.com/gezerwezer/tweetnook/issues
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: archive,bookmarks,cli,tweets,twitter/x
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Requires-Dist: fastapi<1,>=0.110
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: lancedb<0.35,>=0.34
+Requires-Dist: loguru<1,>=0.7
+Requires-Dist: platformdirs>=4.9.4
+Requires-Dist: pyarrow<23,>=20
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: rich<14,>=13
+Requires-Dist: tqdm<5,>=4.66
+Requires-Dist: typer<1,>=0.12
+Requires-Dist: uvicorn<1,>=0.29
+Provides-Extra: automated-tagging
+Requires-Dist: google-genai<3,>=2.12.1; extra == 'automated-tagging'
+Requires-Dist: pillow<12.0,>=10.0; extra == 'automated-tagging'
+Description-Content-Type: text/markdown
+
+# TweetNook
+
+TweetNook is a self-hosted archive for your Twitter/X bookmarks, likes, and tweets.
+Run it on your own computer or  server, import an archive downloaded from
+Twitter/X, keep it updated with automated syncs, and browse everything in a Web UI from
+your network. Search by words, author, date, or tag to find something you saved
+without scrolling through your account.
+
+## Features
+
+- **Archive your tweets:** save bookmarks, likes, and your own tweets, along with replies and quoted tweets
+- **Import existing data:** bring in an official Twitter/X archive.
+- **Browse in your browser:** read saved threads, view photos and videos, and
+  explore quoted tweets and articles.
+- **Search and organize:** combine search filters, add your own tags, and edit
+  local descriptions.
+- **Automated tagging:** with an optional add-on, you can use Gemini to suggest tags and describe media.
+- **Keep it up to date:** run a sync from the web app or terminal, or schedule
+  regular syncs.
+- **Unavailable-tweet recovery:** periodically recheck
+  for unavailable tweets that might return.
+- **Export your collection:** save tweet data as JSON for use in other tools.
+
+## Project background
+
+This project began as a fork of the [upstream project](https://github.com/lhl/tweetxvault),
+which provides the foundation for this work. This version is developed independently.
+
+Thanks to [rrika](https://github.com/rrika) for sharing their
+[archive like-order research](https://github.com/lhl/tweetxvault/issues/2).
+
+> [!NOTE]
+> If you are upgrading from an older upstream installation that uses LanceDB, see the [migration instructions](docs/maintenance.md#upgrade-or-migrate-an-older-archive).
+
+The original project provides the foundation for syncing, archive imports, media
+downloads, thread expansion, article retrieval, and link previews. This fork is
+developed independently and continues to build on that foundation.
+
+## Getting started
+
+You need **macOS or Linux** and **Python 3.12 or newer**. Live syncing also needs
+a browser signed in to your Twitter/X account. You can import a downloaded archive
+without connecting to Twitter/X first.
+
+### 1. Install
+
+Install TweetNook with pip:
+
+```bash
+python3 -m pip install tweetnook
+````
+
+To include automated tagging support:
+
+```bash
+python3 -m pip install "tweetnook[automated-tagging]"
+```
+
+### 2. Install the service
+
+For a persistent homelab/server installation, install TweetNook as a system service:
+
+```bash
+sudo tweetnook service install
+```
+
+This installs and enables the TweetNook service so it starts automatically at boot and keeps running in the background.
+
+Check its status with:
+
+```bash
+tweetnook service status
+```
+
+You can also manage it with:
+
+```bash
+sudo tweetnook service restart
+sudo tweetnook service stop
+sudo tweetnook service start
+```
+
+### 3. Open TweetNook
+
+After the service starts, open the Web UI using the address shown by TweetNook, for example:
+
+```text
+http://192.168.1.50:8000
+```
+
+On first launch, the Web UI will guide you through setup.
+
+
+## Everyday use
+
+### Keep your archive up to date
+
+Run `tweetnook sync` again whenever you want to save new bookmarks and likes.
+To automate it, open **Settings → Schedule**, choose when to run, and save.
+The TweetNook server/service must stay running for scheduled syncs to work;
+the browser can be closed. Your own tweets still use the separate
+`tweetnook sync tweets` command.
+
+| Task | Command |
+|---|---|
+| Save bookmarks only | `tweetnook sync bookmarks` |
+| Save likes only | `tweetnook sync likes` |
+| Continue collecting older history | `tweetnook sync --backfill` |
+| Limit collection to five pages each | `tweetnook sync --limit 5` |
+| Skip media downloads for this sync | `tweetnook sync --skip-media` |
+| View archive counts and progress | `tweetnook stats` |
+| Browse the latest saved tweets in the terminal | `tweetnook view all --limit 20` |
+
+A sync page normally contains up to 20 tweets; `--limit` counts pages, not tweets.
+The limit does not bound all follow-up work. Run one archive job at a time and
+read the final summary for any downloads or lookups that need another attempt.
+
+Use **Stop Task** in the web app or **Ctrl+C** in the terminal to interrupt a job.
+Wait for it to finish stopping before starting another. Stopping TweetNook also asks its active Web or scheduled job to stop gracefully,
+preserving already committed work.
+
+### Search saved tweets
+
+Type words and filters together in the web app's search box:
+
+| Find… | Query |
+|---|---|
+| An exact phrase | `"night sky"` |
+| Images from an author | `from:alice has:image` |
+| Tweets from January 2026 | `since:2026-01-01 until:2026-02-01` |
+| A local tag | `tag:"read later"` |
+| Links, excluding reposts | `has:links -is:retweet` |
+
+The same queries work in the terminal:
+
+```bash
+tweetnook search '"night sky" has:image' --sort newest --limit 20
+```
+
+Dates use UTC, and `until` excludes the date entered. See
+[Search](docs/search.md) for all filters and search limits.
+
+### Add tags
+
+Open a tweet's menu in the web app to add tags or a description. Click a tag to
+find related tweets. **Settings → Tags** lets you merge or delete tags across
+your archive.
+
+### Fill in missing details
+
+Normal sync handles follow-up work automatically. You can also run individual
+jobs when you need them:
+
+```bash
+tweetnook import enrich
+tweetnook threads expand
+tweetnook media download --retry-failed
+```
+
+These commands fill in eligible missing details, expand saved conversations, and
+retry media downloads. Run only the jobs you need. See
+[Enrichment](docs/enrichment.md) for articles and link previews too.
+
+## Optional Gemini tagging
+
+Gemini can suggest tags for text and media tweets and add media descriptions.
+To install support in the active pip environment:
+
+```bash
+python -m pip install "tweetnook[automated-tagging]"
+```
+
+Restart the TweetNook server afterward. For a systemd installation, use the
+service restart command; for a foreground `tweetnook serve` process, stop and
+start it again. Developers using uv can install the extra once with
+`uv sync --extra automated-tagging`. No runtime `--extra` flag is needed.
+
+Open **Settings → Automated Tagging**, enable the controls, enter your Gemini API
+key, choose a model and Free or Paid mode, and set the usage limits. Try one
+archived tweet with **Test run**, then save when you want tagging enabled.
+
+Once saved and enabled, tagging runs after sync. To tag existing eligible tweets
+without syncing:
+
+```bash
+tweetnook tag
+```
+
+Tagging sends selected content to Google. Test runs also use real requests and
+can consume quota or incur charges, though they do not save generated tags.
+Read [Automated tagging](docs/automated-tagging.md) for setup, privacy,
+and spend controls.
+
+## Your files and backups
+
+| System | Default data folder |
+|---|---|
+| macOS | `~/Library/Application Support/tweetnook` |
+| Linux | `~/.local/share/tweetnook` |
+
+The folder contains the archive database, downloaded media, tags, and activity
+history. [Configuration](docs/configuration.md#resolved-directories)
+explains custom locations.
+
+To back up, stop the app and all archive jobs, then copy the **complete data
+folder** and your configuration. Keep original Twitter/X downloads separately.
+[Backups and maintenance](docs/maintenance.md) covers restoring
+and checking a backup.
+
+To export tweet data for analysis or another tool:
+
+```bash
+tweetnook export json --out my-tweets.json
+```
+
+JSON exports do not include media files or everything needed to restore an
+archive. Use a full folder backup for recovery.
+
+
+## Documentation and help
+
+Use `tweetnook --help` to list commands or add `--help` to a command, such as
+`tweetnook sync --help`.
+
+| Guide | Covers |
+|---|---|
+| [User guide](docs/README.md) | All feature guides and references |
+| [Syncing](docs/syncing.md) | Older history, resuming work, and sync options |
+| [Web app](docs/web-app.md) | Browsing, settings, schedules, and activity |
+| [Importing](docs/importing.md) | Official Twitter/X archives |
+| [Configuration](docs/configuration.md) | Settings, defaults, and file locations |
+| [CLI reference](docs/cli-reference.md) | Commands and options |
+| [Troubleshooting](docs/troubleshooting.md) | Common errors and next steps |
+| [Development guide](docs/development/README.md) | Architecture, tests, and contribution workflow |
+
+## License
+
+[Apache License 2.0](LICENSE). See [upstream](https://github.com/lhl/tweetxvault)
+for the original project.