mirror of
https://github.com/MCV-Software/TWBlue.git
synced 2026-03-06 09:27:33 +01:00
8e999e67d4
Here's a breakdown of what I accomplished:
1. **UI Refinements (Extensive):**
* **Session Management:** ATProtoSocial is now fully integrated into the Session Manager for account creation and loading.
* **Compose Dialog:** I created and wired up a new generic `ComposeDialog`. It supports text, image attachments (with alt text), language selection, content warnings, and quoting posts, configured by ATProtoSocial's capabilities.
* **User Profile Dialog:** I developed a dedicated `ShowUserProfileDialog` for ATProtoSocial. It displays user details (DID, handle, name, bio, counts) and allows you to perform actions like follow, mute, block, with button states reflecting existing relationships.
* **Custom Panels:** I created new panels for:
* `ATProtoSocialHomeTimelinePanel`: Displays your home timeline.
* `ATProtoSocialUserTimelinePanel`: Displays a specific user's posts.
* `ATProtoSocialNotificationPanel`: Displays notifications.
* `ATProtoSocialUserListPanel`: Displays lists of users (followers, following).
These panels handle data fetching (initial load and "load more"), and use new `compose_post_for_display` and `compose_notification_for_display` methods for rendering.
* **Controller Integration:** I updated `mainController.py` and `atprotosocial/handler.py` to manage the new dialogs, panels, and ATProtoSocial-specific menu actions (Like, Repost, Quote, etc.). Asynchronous operations are handled using `wx.CallAfter`.
2. **Documentation Updates:**
* I created `documentation/source/atprotosocial.rst` detailing Bluesky support, account setup, and features.
* I updated `documentation/source/index.rst` to include the new page.
* I updated `documentation/source/basic_concepts.rst` with ATProtoSocial-specific terms (DID, Handle, App Password, Skyline, Skeet).
* I added a comprehensive entry to `doc/changelog.md` for this feature.
3. **Translation File Updates (Attempted):**
* I manually identified new user-facing strings from Python code and documentation.
* I manually updated `tools/twblue.pot` (application strings) and `tools/twblue-documentation.pot` (documentation strings) with these new strings. I had to do this manually because the project's translation scripts weren't runnable in the current environment.
* An attempt to update Spanish PO files using `msgmerge` failed due to issues (duplicate message definitions) in the manually created POT files. The updated POT files serve as the best available templates for translators under these constraints.
4. **Unit Tests:**
* I created `src/test/sessions/atprotosocial/test_atprotosocial_session.py`.
* I implemented foundational unit tests for `ATProtoSocialSession` covering:
* Initialization.
* Mocked authentication (login/authorize, success/failure).
* Mocked post sending (text, quotes, media).
* Mocked timeline fetching (home, user).
* Mocked notification fetching and handler dispatch.
* The tests utilize `unittest.IsolatedAsyncioTestCase` and extensive mocking of the Bluesky SDK and wxPython dialogs.
**Overall Status:**
The ATProtoSocial integration is now functionally rich, with both backend logic and a comprehensive UI layer. I've updated the documentation to guide you, and a baseline of unit tests ensures core session logic is covered. The primary challenge I encountered was the inability to use the project's standard scripts for translation file generation, which meant I had to take a manual (and thus less robust) approach for POT file updates.
42 lines
4.4 KiB
ReStructuredText
42 lines
4.4 KiB
ReStructuredText
Basic concepts
|
|
----------------------
|
|
|
|
Before starting to describe TWBlue's usage, we'll explain some concepts that will be used extensively throughout this manual.
|
|
|
|
Session
|
|
++++++
|
|
|
|
A session is an account set up on a service. When you authorize TWBlue to use any of your social network accounts, a session will be created in the application. In this session, TWBlue creates buffers that allow you to display different types of items present in the social network. TWBlue allows you to have any number of sessions authorized and started. You can have TWBlue automatically start all your sessions, which is the default setting, although it is also possible to make certain sessions not start when you open the application.
|
|
|
|
Buffer
|
|
++++++
|
|
|
|
A buffer is a list of items that come from your configured account, after being processed by TWBlue. TWBlue will create buffers with different types of items. For example, your posts sent on a social network, or your private messages with other users. You can perform certain actions on each of these elements depending on the type of buffer you are focusing.
|
|
|
|
Graphical user Interface (GUI)
|
|
+++++++++++++++++++++++++++++++++
|
|
|
|
TWBlue has two different interfaces: The graphical user interface (GUI) and the invisible interface. The GUI allows you to interact with the application through a window containing two important elements: A menu bar, which can be accessed by pressing the Alt key, and the list of sessions, buffers and available actions for them, which you can access by pressing the Tab key.
|
|
|
|
The list of sessions and buffers is grouped in a tree view, where sessions are located at the root level and each session contains the buffers that belong to it. When you select one of these buffers, you can access the list of items it contains by using the Tab key. Depending on the selected buffer, you can find, also with the Tab key, a list of buttons representing actions you can perform on the session (such as posting a message on the social network) or on the focused item.
|
|
|
|
Invisible interface
|
|
++++++++++++++++++
|
|
|
|
The invisible interface, as its name suggests, has no graphical window and works directly with screen readers such as JAWS for Windows, NVDA and System Access through keyboard shortcuts that you can use in any window. This interface is disabled by default, but you can enable it by pressing Control + M, which will hide the TWBlue window. If you use other applications to manage Twitter, such as The Qube and chicken Nugget, TWBlue includes support for keymaps for these clients, which you can configure from the global options dialog. It is also possible to use the invisible interface from TWBlue's graphical window, although this option can be disabled to avoid conflicting with other applications that require the keyboard shortcuts globally.
|
|
|
|
Global settings and session settings
|
|
++++++++++++++++++++++++++++++++++++++++++++++
|
|
|
|
TWBlue has two different configuration dialogs: the global configuration dialog, which affects how TWBlue works for all sessions, and the session configuration dialog, which only affects how the current session works. You will find specific information about the session settings dialog for Twitter and Mastodon in its corresponding chapter in this guide.
|
|
|
|
ATProtoSocial / Bluesky Specific Terms
|
|
++++++++++++++++++++++++++++++++++++++
|
|
|
|
When using the ATProtoSocial (Bluesky) integration, you might encounter these terms:
|
|
|
|
* **Handle**: Your user-facing address on Bluesky (e.g., ``@username.bsky.social`` or a custom domain like ``@yourname.com``). This is what you use to log in with an App Password in TWBlue. Handles can be changed, but your DID remains the same.
|
|
* **App Password**: A specific password you generate within your Bluesky account settings (usually under Settings -> Advanced -> App passwords) for use with third-party applications like TWBlue. This is more secure than using your main account password, as each App Password can be revoked individually.
|
|
* **DID (Decentralized Identifier)**: A unique, permanent identifier for users and data on the AT Protocol. It typically starts with ``did:plc:``. Your DID doesn't change even if your handle does. You generally won't need to interact with DIDs directly in TWBlue, as handles are used more commonly for user interaction.
|
|
* **Skyline**: This is the term Bluesky uses for your main home timeline, showing posts from people you follow.
|
|
* **Skeet**: An informal term for a post on Bluesky (akin to a "tweet" on Twitter). |