notolog 1.0.2__tar.gz

notolog-1.0.2/CHANGELOG.md

@@ -0,0 +1,308 @@
+# Changelog
+All notologable changes to this project will be documented in this file.
+
+## [1.0.2] - 2024-09-29
+
+### Added
+- Added the index of searched text occurrences within the document, alongside the count of such occurrences. This enhancement provides more detailed search results and helps users locate text more precisely.
+
+### Changed
+- Extracted SearchForm from the ToolBar class into a separate file and updated relevant lexeme names for case-sensitive search.
+
+### Updated
+- Updated themes to enhance the document's search field, ensuring compatibility with the new functionality.
+- Upgraded the `cryptography` package dependency from version '42.0.7' to '43.0.1' or later to incorporate the latest security improvements.
+- Updated tests, particularly for the ToolBar and SearchForm classes.
+
+### Fixed
+- Adjusted the searched occurrence counter to respond to the case-sensitive search checkbox for accurate results.
+
+## [1.0.1] - 2024-09-15
+
+### Added
+- Count occurrences of searched text within a document, display the count in the search field, and enable/disable navigation buttons accordingly.
+- Added `get_by_scope()` method to the `Lexemes` class to retrieve all lexemes related to a particular scope.
+
+### Changed
+- Renamed the lexeme key from 'md_background_color_blockquote_friendly' to 'md_background_color_blockquote_inner', which contains the background color value for inner elements within a blockquote.
+
+### Updated
+- Modules tabs now respond to language changes in settings by reloading the `settings_dialog` scope.
+- Updated the 'Nocturne' theme styles (comments, blockquote inner elements background, and the selected tree element style), along with minor tweaks to other themes.
+- Updated tests related to the `Lexemes` class functionality.
+
+### Fixed
+- Fixed an issue where the Esc-key hidden AI Assistant dialog did not reopen after clicking its button.
+- Fixed markdown highlighting for header tags when the header content contains emojis.
+- Fixed the potential font size shift of the settings tab widget when changing themes.
+- Fixed the persisted code block background color in an open document when changing themes in the settings.
+
+## [1.0.0] - 2024-09-01
+
+### Added
+- New dark theme 'Nocturne' for nighttime coders.
+
+### Fixed
+- Fixed the issue with updating settings group titles during interactive language changes.
+- Resolved `pytest` warning regarding the default fixture loop scope in `asyncio`.
+
+### Changed
+- Updated the approach for assigning styles to settings group titles.
+
+## [0.9.9] - 2024-08-18
+
+### Added
+- Notolog is now available for installation via Conda Forge. Installation instructions and a version badge have been added to the `README.md` file.
+- Introduced the ability to create a new directory from the file tree context menu.
+
+### Changed
+- Adjusted palette highlight colors (e.g., selection, search, context menu active background) for the 'Default' and 'Noir Dark' themes.
+
+### Fixed
+- The tree filter now returns to the initial directory in the file tree when the filter text is cleared using the backspace key.
+
+## [0.9.8] - 2024-08-04
+
+### Added
+- Added the ability to copy the file path from the file tree context menu.
+- Added 'gpt-4o-mini' and 'gpt-4-turbo' to the list of supported models in the OpenAI API module.
+
+### Updated
+- Updated the URL for new version notifications to point to the latest version page.
+- Hid status bar warnings in Edit Mode, as the warnings are now relevant only in View Mode.
+
+## [0.9.7] - 2024-07-14
+
+### Added
+- Added a warning label to the status bar to indicate mismatches between `<details>` blocks' open and close tags.
+
+### Updated
+- Enhanced the processing of collapsible blocks with several updates:
+  - Inserted a zero-width space before expandable anchor tags to prevent continuous anchor sequences.
+  - Preserved 'class' attributes and other properties when processing `<details>` and `<summary>` tags.
+  - Included the block's summary within the QUrl fragment for better linkage.
+  - Updated corresponding UI styles for consistency and visual integration.
+
+### Fixed
+- Improved handling of nested expandable/collapsible blocks at the same level.
+- Corrected an issue where clicking on the very first character of an expanded block would misplace the expansion.
+
+## [0.9.6] - 2024-06-30
+
+### Added
+- Added Markdown to HTML conversion within the expandable blocks.
+
+### Changed
+- Highlighted '@todo' token even if there is no space after it but before the end of the line.
+
+### Updated
+- Updated translations for the AI Assistant and related functionalities, including the On Device LLM module.
+
+### Fixed
+- Fixed a missing tooltip when copying messages from the AI Assistant dialog.
+- Fixed an issue where a button in the AI Assistant could become stuck if the request exceeded the length limit. Also added more service messages within the AI Assistant to address potential errors.
+
+## [0.9.5] - 2024-06-23
+
+### Added
+- Added `pyproject.toml` file to support the modern way of building packages.
+- Added a development and test tools installation script that gets data directly from `pyproject.toml`.
+- Added a button to send requests and stop inference for the AI Assistant.
+
+### Changed
+- Renamed `main.py` to `app.py` to allow running the app with the `python -m notolog.app` command.
+- The application has been tested with less strict dependencies, using version ranges to ensure compatibility and flexibility.
+
+### Updated
+- Updated `README.md` with current and additional information about dev tools installation, and other changed parts.
+
+### Fixed
+- Fixed building the wheel on the Windows platform.
+- Added `QT_API` environment variable to fix Windows CLI run.
+
+## [0.9.5b1] - 2024-06-16
+
+### Added
+- Modular functionality with extendable settings and lexemes.
+- Introduced the 'On Device LLM' module using ONNX Runtime GenAI, enabling local, CPU-optimized versions of LLMs like Phi-3 without requiring internet access. Added two new packages, `onnxruntime_genai` and `numpy`, to support this feature. Supported systems include Linux and Windows (support for macOS is in progress).
+
+### Changed
+- Transformed the OpenAI API into a dedicated module.
+- Moved descriptions of third-party packages and their licenses to the `ThirdPartyNotices.md` file from the README.md.
+
+### Updated
+- Enhanced the AI Assistant to support multi-turn conversations with optional 'no memory' requests, improved token count management, and added a stop button functionality to halt inference.
+- Enabled saving of the entire AI Assistant conversation; individual messages can now be copied to the clipboard as well.
+- Implemented caching of settings, which can be reset via the main menu.
+
+### Fixed
+- Resolved an issue where the code block background color was indiscernible in the Dark Noir theme.
+- Corrected anchors processing for headers using the 'toc' (Table of Contents) markdown extension.
+
+## [0.9.1b8] - 2024-05-25
+
+### Added
+- Added `typing_extensions` package, which is also automatically installed with the `emoji` package.
+- New tests and test-related updates, particularly complex async tests for `ImageDownloader`.
+
+### Updated
+- Updated the following packages to their latest versions: `PySide6` (including `PySide6_Addons` and `PySide6_Essentials`) to version 6.7.1, `pytest` to version 8.2.1, `pytest-asyncio` to version 0.23.7, `cffi` to version 1.17.0rc1, and `emoji` to version 2.12.1.
+- Added processing for the Shift + Enter keyboard combination to avoid soft line breaks, which may alter the perception of how soft line breaks function.
+- Updated the package's `setup.py` to include supported languages and additional package information.
+- Updated the functionality for getting and storing protected fields in settings, including refactoring and error fixes (re-setup of corresponding values may be required).
+- Updated `AppConfig` with additional settings-related options.
+- Various `Flake8` linter fixes to ensure the code meets the PEP 8 style guide, along with McCabe complexity updates (current complexity check level is 15).
+- Updated and optimized the content of the `README.md` file to enhance the sections on third-party components, and tests-related topics.
+
+### Changed
+- Slightly reduced the await time for the async highlighter to make the editing mode more responsive to changes involved in syntax highlighting (experimental).
+- Improved the error-proofing of async queue processing upon app closing, particularly if background processes like highlighting or others are still in progress.
+
+### Fixed
+- Fixed an issue where resources might be downloaded twice.
+- Resolved a problem with the toolbar context menu being unresponsive.
+
+## [0.9.1b5] - 2024-05-19
+
+### Added
+- Introduced a GitHub workflow for tests, incorporating Flake8 and pytest coverage reports to maintain high standards of code quality and ensure comprehensive test coverage.
+- Added the app's organization name, app name, and version to facilitate correct settings storage.
+- Added a media directory to the app_config.toml.
+- App settings now support encrypted values to keep sensitive data, like API keys, secure. The encryption key is generated once and stored in the app config file. A Settings helper class was also added.
+- New tomli_w package added to support TOML-file writing.
+
+### Updated
+- Tests updated to support multi-platform execution.
+- Used `os.sep` to ensure correct path separators on each OS and `os.path.normpath()` to normalize path separators.
+- Updated the description and disclaimers text in README.md; added a "Code Quality and Test Coverage" paragraph.
+
+### Changed
+- Changed the approach to not create a resource directory upfront before any file is available to save.
+- Moved async highlighter functionality to a dedicated file.
+- Adjusted links markdown highlighter to allow highlighting web links within lines of markdown blocks, and adjusted the web links regex accordingly.
+- Refined the AppConfig object to implement the singleton pattern, enabling it to automatically generate the app's config file rather than relying on a predefined version.
+
+### Fixed
+- Fixed a potential error in the image downloader when the property is None upon canceling tasks on exiting the app.
+- Updated the resource folder path according to the currently active file.
+
+## [0.9.1b4] - 2024-05-12
+
+### Added
+- Introduced the pytest-asyncio package to support testing of asyncio code with pytest, enhancing the robustness and reliability of unit tests.
+- Added the `.gitattributes` file that was previously omitted to ensure consistent Git configurations across various environments.
+
+### Updated
+- Improved the processing and completion of tasks in the asynchronous syntax highlighter, enhancing efficiency and stability.
+- Expanded the `.gitignore` file with additional entries to better manage the files included in version control, such as ignoring more temporary files and build artifacts.
+
+## [0.9.1b3] - 2024-05-11
+
+### Added
+- Introduced the CODE_OF_CONDUCT.md file to promote a respectful and positive environment for all contributors and participants. This document outlines our commitment to providing a harassment-free experience for everyone and offers guidelines for respectful communication practices.
+- Support for highlighting tables in markdown edit mode, enhancing the editing experience.
+- A new EnumBase class to incorporate common methods across enums, improving code reusability.
+- Additional tests to increase coverage and ensure the stability of new features.
+
+### Changed
+- Renamed the main package directory from app to notolog and moved main.py into the notolog directory to better reflect the project structure.
+- Refined the handling of external and local links, as well as local files, now routing them through a unified links router for improved security and consistency.
+- Updated the table styles in view mode across all themes for more consistent visual presentation.
+- Eliminated the need for a preliminary empty line to highlight lists in markdown edit mode, enhancing the user experience by simplifying text formatting.
+
+### Updated
+- Enhanced the language selection mechanism to prefer the system language by default, with a fallback to a predefined language if the system language is not available.
+- Optimized the checking of image downloader statuses and the updating of signal processing for increased performance and reliability.
+
+### Fixed
+- Corrected the processing for confirming external links to eliminate unintended navigational behaviors and enhance user security.
+- Various minor fixes to address small issues in the codebase, enhancing stability and performance without significantly changing functionality.
+
+## [0.9.1b1] - 2024-05-06
+
+### Added
+- New interface language: Dutch
+
+### Updated
+- Upgraded `cryptography` to version 42.0.7 to align with the latest standards and enhance security.
+
+### Changed
+- Updated requirements.txt to match the actual package list.
+
+## [0.9.1b0] - 2024-05-05
+
+### Added
+- New interface languages: Finnish and Swedish, expanding accessibility for users in these regions.
+- Additional entries to the `.gitignore` and `.gitattributes` files to improve version control practices.
+- A dedicated `app_config.toml` file with initial configuration parameters, simplifying initial setup and customization.
+
+### Updated
+- Updated the `Libraries and Licenses` section within the README.md file to provide comprehensive information about third-party dependencies and their licenses.
+- Updated `cryptography` to version 42.0.6 and `Pygments` to version 2.18.0 to ensure compatibility with the latest standards and to incorporate the newest features and security enhancements.
+
+### Changed
+- Modified file handling: The file header can now be the only content of the file, streamlining setups where minimal data is required.
+- Updated encryption description to clarify that Fernet uses AES-128 for encryption, derived from a 256-bit key, accurately reflecting the cryptographic standards employed.
+
+## [0.9.0b11] - 2024-05-04
+
+### Added
+- Support for embedding external images within documents, with caching.
+- Option to auto-save downloaded image resources on local disk and reuse them in subsequent document sessions.
+- New interface languages: Greek, Hindi, Turkish.
+- Expanded example content and resources.
+- Added `CHANGELOG.md` to document all notable changes to the project, enhancing transparency and trackability for developers and users alike.
+
+### Updated
+- Updated pytest to version 8.2.0 to take advantage of improved test suite performance and new features. (Previously listed under "Changed")
+
+### Changed
+- Updated pip installer related packages and file structure.
+- Current directory now persists during file events, even if no files are actively open.
+- Minor logo adjustment.
+
+### Fixed
+- Resolved sudden crashes when switching between edit and view modes.
+- Addressed UI style issues for improved text visibility under various color schemes.
+
+## [0.9.0b10] - 2024-04-29
+
+### Changed
+- Updated pip installer related packages and file structure.
+
+### Fixed
+- Corrected startup failures following pip installation.
+
+## [0.9.0b0] - 2024-04-29
+
+### Added
+- Initial release features, open sourced under the MIT license for full transparency and collaboration.
+- Markdown syntax highlighting:
+    - Editor mode offers smooth highlighting tailored specifically for Notolog by our development team, including line numbers and extended syntax highlighting.
+    - View mode utilizes the Python Markdown library for seamless rendering of Markdown syntax.
+    - Supports multi-line block open-close tokens for enhanced readability and structure.
+- Multi-platform support: Compatible with all major platforms where Python is installed, ensuring accessibility across operating systems.
+- Accessible features:
+    - Clear and accessible descriptions for enhanced usability.
+    - Font size adjustment for better readability.
+- Background and cross-action save changes experience:
+    - Automatically saves changes in the background to ensure data integrity and minimize user intervention.
+    - Seamlessly handles unsaved changes when performing cross-actions, providing a smooth user experience.
+- Search functionality:
+    - Enables users to search within the opened file.
+    - Quick search by file name within the tree for efficient navigation and content retrieval.
+- File meta-headers in the form of HTML comments to avoid excess visibility.
+- Password-based file symmetric encryption and decryption:
+    - Utilizes AES-256 in CBC (Cipher Block Chaining) mode with secure key management via PBKDF2HMAC employing SHA-256, provided by the Fernet library.
+    - File meta-headers keep encryption parameters for seamless decryption processes.
+- Translations-friendly file structure:
+    - Supports several languages out of the box, with provisions for adding and supporting additional languages.
+- Color themes support:
+    - Includes predefined color themes for customizing the editor's appearance in both light and dark modes.
+- Hotkeys support:
+    - Supports essential hotkeys like Ctrl+S for saving and Ctrl+F for searching, with plans for further expansion.
+- In-line context menus:
+    - Right-click context menu options in the file tree for file rename and delete actions.
+    - Customizable toolbar with right-click functionality to show/hide icons based on user preferences.
+- A suite of unit tests to ensure code reliability and maintainability, providing confidence in the editor's functionality.
+- AI Assistant UI integrated with the OpenAI API, with plans to extend support to other providers.

notolog-1.0.2/CODE_OF_CONDUCT.md

@@ -0,0 +1,48 @@
+<!-- {"notolog.app": {"created": "2024-05-11 11:15:29.656338", "updated": "2024-05-11 11:15:29.656338"}} -->
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we, as contributors and maintainers, pledge to make participation in our project and our community a harassment-free experience for everyone. This is regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contribute to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct. They can also ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at dev&#064;notolog.app. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

notolog-1.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Vadim Bakhrenkov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.