You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Pull Request Template
### Prerequisites
<!-- Take a couple of minutes to help our maintainers work faster by
checking of the pre-requisites. -->
<!-- To tick the checkboxes replace the space with an 'x', so [ ]
becomes [x] . -->
- [x] I have
[searched](https://github.com/DefinetlyNotAI/Logicytics/pulls) for
duplicate or closed issues.
- [x] I have read the [contributing
guidelines](https://github.com/DefinetlyNotAI/Logicytics/blob/main/CONTRIBUTING.md).
- [x] I have followed the instructions in the
[wiki](https://github.com/DefinetlyNotAI/Logicytics/wiki) about
contributions.
- [x] I have updated the documentation accordingly, if required.
- [x] I have tested my code with the `--dev` flag, if required.
### PR Type
<!-- Take a couple of minutes to help our maintainers work faster by
telling us what is the PR guided on. -->
<!-- To tick the checkboxes replace the space with an 'x', so [ ]
becomes [x] . -->
- [x] Bug fix <!-- Non-Breaking Bug Fix - Usually relates to fixing an
issue -->
- [x] Deprecation Change <!-- Removing a deprecation -->
- [x] New feature <!-- Non-Breaking Change that adds a new feature -->
- [x] Refactoring <!-- Non-Breaking Change that modifies existing code
to refactor it to become more organised -->
- [x] Documentation
update <!-- Non-Breaking Change that modifies existing documentation to
refactor it or add extra comments - either wiki, md files or code is
included here -->
- [x] ⚠️ Breaking change ⚠️ <!-- Breaking Bug Fix / New Addition that
changes how Logicytics works -->
### Description
<!-- REQUIRED: Provide a summary of the PR and what you expected to
happen. -->
<!-- Made by copilot -->
This pull request includes significant changes to the `Logicytics`
project, focusing on code refactoring, logging improvements, and the
removal of deprecated features. The most important changes include the
refactoring of flag handling, the addition of detailed logging, and the
cleanup of deprecated features.
#### Code Refactoring and Improvements:
*
[`CODE/Logicytics.py`](diffhunk://#diff-44a988332704ab86171610dcfe391d08df0f70f8177c3463e6e089aec9c5baa0L78-R87):
Refactored `get_flags` function to simplify flag retrieval and logging.
Removed deprecated features `extra` and `unzip_extra` from
`handle_special_actions`. Added the `Logicytics` main function to
encapsulate the main process logic.
[[1]](diffhunk://#diff-44a988332704ab86171610dcfe391d08df0f70f8177c3463e6e089aec9c5baa0L78-R87)
[[2]](diffhunk://#diff-44a988332704ab86171610dcfe391d08df0f70f8177c3463e6e089aec9c5baa0L138-L145)
[[3]](diffhunk://#diff-44a988332704ab86171610dcfe391d08df0f70f8177c3463e6e089aec9c5baa0L176-L183)
[[4]](diffhunk://#diff-44a988332704ab86171610dcfe391d08df0f70f8177c3463e6e089aec9c5baa0L370-R359)
[[5]](diffhunk://#diff-44a988332704ab86171610dcfe391d08df0f70f8177c3463e6e089aec9c5baa0R373-R376)
#### Logging Enhancements:
*
[`CODE/_debug.py`](diffhunk://#diff-cddd7a4c003554a2fce729e954458aa39d397bf2910c94cdd093f39747848061R181-R188):
Added detailed logging to `python_version` and `debug` functions.
[[1]](diffhunk://#diff-cddd7a4c003554a2fce729e954458aa39d397bf2910c94cdd093f39747848061R181-R188)
[[2]](diffhunk://#diff-cddd7a4c003554a2fce729e954458aa39d397bf2910c94cdd093f39747848061R222)
*
[`CODE/_dev.py`](diffhunk://#diff-8789fb31b28e15638e2117ffc4916c7d17b62b207559877dce4b69ffcfcfaa09L50-R51):
Enhanced `_prompt_user` function with more user-friendly prompts and
added logging to `dev_checks` function.
[[1]](diffhunk://#diff-8789fb31b28e15638e2117ffc4916c7d17b62b207559877dce4b69ffcfcfaa09L50-R51)
[[2]](diffhunk://#diff-8789fb31b28e15638e2117ffc4916c7d17b62b207559877dce4b69ffcfcfaa09R65)
[[3]](diffhunk://#diff-8789fb31b28e15638e2117ffc4916c7d17b62b207559877dce4b69ffcfcfaa09L90-R106)
[[4]](diffhunk://#diff-8789fb31b28e15638e2117ffc4916c7d17b62b207559877dce4b69ffcfcfaa09L127-R133)
*
[`CODE/bluetooth_details.py`](diffhunk://#diff-d15430c77b28ebd438edeec503e4666192dd9e256cc386ebcdc6a5012b398d59L1-R12):
Improved logging in `get_bluetooth_device_details` and
`_query_bluetooth_devices`.
[[1]](diffhunk://#diff-d15430c77b28ebd438edeec503e4666192dd9e256cc386ebcdc6a5012b398d59L1-R12)
[[2]](diffhunk://#diff-d15430c77b28ebd438edeec503e4666192dd9e256cc386ebcdc6a5012b398d59L30-R39)
[[3]](diffhunk://#diff-d15430c77b28ebd438edeec503e4666192dd9e256cc386ebcdc6a5012b398d59L52-R74)
[[4]](diffhunk://#diff-d15430c77b28ebd438edeec503e4666192dd9e256cc386ebcdc6a5012b398d59L97)
*
[`CODE/bluetooth_logger.py`](diffhunk://#diff-1876b6113c2e2b1d8fa0dfe09ab9a1b20d3fb52852256fd0bbdd1f8bfc9ce27aL1-R4):
Added detailed logging and documentation to functions `save_to_file`,
`run_powershell_command`, `parse_output`,
`get_paired_bluetooth_devices`, and `log_bluetooth`.
[[1]](diffhunk://#diff-1876b6113c2e2b1d8fa0dfe09ab9a1b20d3fb52852256fd0bbdd1f8bfc9ce27aL1-R4)
[[2]](diffhunk://#diff-1876b6113c2e2b1d8fa0dfe09ab9a1b20d3fb52852256fd0bbdd1f8bfc9ce27aL12-R23)
[[3]](diffhunk://#diff-1876b6113c2e2b1d8fa0dfe09ab9a1b20d3fb52852256fd0bbdd1f8bfc9ce27aL24-R47)
[[4]](diffhunk://#diff-1876b6113c2e2b1d8fa0dfe09ab9a1b20d3fb52852256fd0bbdd1f8bfc9ce27aL38-R95)
[[5]](diffhunk://#diff-1876b6113c2e2b1d8fa0dfe09ab9a1b20d3fb52852256fd0bbdd1f8bfc9ce27aR117-R128)
[[6]](diffhunk://#diff-1876b6113c2e2b1d8fa0dfe09ab9a1b20d3fb52852256fd0bbdd1f8bfc9ce27aR143-R149)
#### Deprecated Feature Removal:
*
[`CODE/Logicytics.py`](diffhunk://#diff-44a988332704ab86171610dcfe391d08df0f70f8177c3463e6e089aec9c5baa0L138-L145):
Removed deprecated features `extra` and `unzip_extra` from
`handle_special_actions`.
[[1]](diffhunk://#diff-44a988332704ab86171610dcfe391d08df0f70f8177c3463e6e089aec9c5baa0L138-L145)
[[2]](diffhunk://#diff-44a988332704ab86171610dcfe391d08df0f70f8177c3463e6e089aec9c5baa0L176-L183)
#### Miscellaneous Changes:
*
[`.github/ISSUE_TEMPLATE/bug_report.yml`](diffhunk://#diff-637f7b97bba458badb691a1557c3d4648686292e948dbe3e8360564378b653efL47-R49):
Renamed `flags` to `flags_list` for consistency.
*
[`CODE/_dev.py`](diffhunk://#diff-8789fb31b28e15638e2117ffc4916c7d17b62b207559877dce4b69ffcfcfaa09L3-R6):
Reorganized imports and added `EXCLUDE_FILES` to `dev_checks` function.
[[1]](diffhunk://#diff-8789fb31b28e15638e2117ffc4916c7d17b62b207559877dce4b69ffcfcfaa09L3-R6)
[[2]](diffhunk://#diff-8789fb31b28e15638e2117ffc4916c7d17b62b207559877dce4b69ffcfcfaa09L90-R106)
*
[`CODE/cmd_commands.py`](diffhunk://#diff-7422c369c3c1828e52aa953e050cf03d003b07f6f0a244908eb117002bbc4be1R30):
Added `__main__` check to execute commands.
These changes aim to enhance code readability, improve logging for
debugging purposes, and remove outdated features to maintain code
quality.
### Motivation and Context
<!-- REQUIRED: Why is this PR required? What problem does it solve? Why
do you want to do it? -->
To move in version 3.3.0 and fix many bugs and improve Logicytics
### Credit
<!-- If this PR is a contribution, please mention the contributors here
using the appropriate syntax. -->
<!--
### File-Created/CONTRIBUTION by MAIN-Username
What you did, created, removed, refactored, fixed, or discovered.
- [Your GitHub Username](https://github.com/YourGitHubLink)
- [Your GitHub Username](https://github.com/YourGitHubLink) etc...
-->
_N/A_
### Issues Fixed
<!-- REQUIRED: What issues will be fixed? (Format: "#50, #23" etc.) if
none exist type _N/A_ -->
_N/A_
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
## Release Notes for Logicytics v3.3.0
### New Features
- Enhanced flag suggestion system with historical data tracking.
- Improved Bluetooth data collection and logging.
- Added support for more file types in sensitive data mining.
- Expanded system information and memory snapshot capabilities.
- New configuration options for user preferences and accuracy settings.
- Added a new XML configuration file for CSV file handling.
### Improvements
- Refined error handling across multiple modules.
- Enhanced logging and debugging mechanisms.
- Updated configuration management.
- Improved thread-based execution for certain operations.
- Streamlined control flow to prevent unintended execution during
imports.
### Bug Fixes
- Resolved issues with file parsing and system checks.
- Improved compatibility with various system configurations.
### Dependency Updates
- Added `sentence-transformers` for advanced flag suggestions.
- Added `WMI` for improved Windows system interactions.
- Restored `scapy` package.
- Removed `transformers` and `pathlib` packages.
### Security
- Updated supported version statuses.
- Enhanced logging for better tracking and debugging.
### Deprecations
- Removed some deprecated actions and methods.
- Streamlined code structure for better maintainability.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
0 commit comments