Refactor project structure and update documentation#1
Open
EvilCheetah wants to merge 4 commits intobennjordan:mainfrom
Open
Refactor project structure and update documentation#1EvilCheetah wants to merge 4 commits intobennjordan:mainfrom
EvilCheetah wants to merge 4 commits intobennjordan:mainfrom
Conversation
added 4 commits
April 2, 2026 14:27
- Added pyproject.toml and uv.lock for dependency management - Set python version to 3.10 and higher - Included pyshark as a project dependency - Added a .gitignore for Python and common IDEs
- Included dependency:install task to sync the virtual environment with uv - Included dependency:lock task to export dependencies to requirements.txt and pylock.toml for users with no uv installed
- Added a Prerequisites section describing required tools - Mentioned optional (recommended) tools for process automation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces several improvements to the project's structure, dependency management, and documentation to make it easier to set up and run.
Key Changes:
uvfor faster and more reliable dependency managementpyproject.tomlanduv.lockto define project metadata and lock dependencies.Taskfile.yamlto provide command automation:task dependency:install: sets up the virtual environment and installs dependencies fromuv.locktask dependency:lock: updates legacyrequirements.txtandpylock.tomlfor users NOT usinguv, i.e. keeping backward compatibility to standard Python toolstask run: runs the main scriptREADME.mdwith:uv+taskfileand manual (viapython,venvandpip) workflows..gitignore(source: NestJS - TypeScript Starter) to keep the repository clean of IDE files, pychache and virtual environments.