willmcgugan / codereviews

Free code reviews for open source projects

╔════════════════════════ Hi there ════════════════════════╗ 🤓 Will McGugan            
║ I'm a freelance software developer, living in Edinburgh, ║ ┣━━ 🐍 Python expert       
║ Scotland. Other than open source software development,   ║ ┃   ┣━━ ⭐ Rich            
║ my passion would be wildlife photography.                ║ ┃   ┣━━ ⭐ PyFilesystem    
║                                                          ║ ┃   ┗━━ ⭐ Lomond          
║ Follow me on twitter @willmcgugan                        ║ ┣━━ 🔧 Full-stack developer
╚══════════════════════════════════════════════════════════╝ ┗━━ 📘 Author              

codereviews's Issues

[Code Review Request] Runtype

What is the name of your project?
Runtype

What is the repo URL?
https://github.com/erezsh/runtype

Is there anything else I should know about the code?
It's pretty short, but maybe a little dense.
Python's "type system" is re-implemented for performance reasons.

Are there any areas you would like me to focus on?
You decide

Have I reviewed this project previously?
No

• I agree for the code review to be public

[Code Review Request] ScanAPI

What is the name of your project?
ScanAPI

What is the repo URL?
Repo

Is there anything else I should know about the code?
We already use a static analysis tool to get some help with finding out issues/antipatterns. Here is the detailed dashboard for it.

Are there any areas you would like me to focus on?
It would be great if you could look into evaluators - code_evaluators

But anything that you think that would help in improving the lib better works for us.

Is this your first review?
Yes

• I agree for the code review to be public

Code review for aiotraceroute

What is the name of your project?

aiotraceroute

What is the repo URL?

https://github.com/NicoAdrian/aiotraceroute

Is there anything else I should know about the code?

No

Are there any areas you would like me to focus on?

All of them ! :)

Have I reviewed this project previously?

No

I agree for the code review to be public

Please review GitGoat

What is the name of your project?
GitGoat

What is the repo URL?
http://github.com/arnica-ext/GitGoat

Is there anything else I should know about the code?
The code may contain secrets, but it is purposely there in order to shorten the "time to hello-world" for anyone who wants to tinker with it.

Are there any areas you would like me to focus on?
The ability for developers or devops teams to run the project quickly

Have I reviewed this project previously?
No

• I agree for the code review to be public

[code review] jenkins-tui

What is the name of your project?
jenkins-tui

What is the repo URL?
https://github.com/chelnak/jenkins-tui

Is there anything else I should know about the code?
It's all powered by textual and rich.

Are there any areas you would like me to focus on?
Along side conventions and best practices i'm really interested in your opinion on my useage of textual.

Have I reviewed this project previously?
No

• I agree for the code review to be public

ohmeow-blurr

What is the name of your project?
Blurr

What is the repo URL?
https://github.com/ohmeow/blurr

Is there anything else I should know about the code?
It's an integration library for fast.ai developers looking to train Hugging Face transformer models ... built in nbdev. The actual python code that makes up the product is found in /blurr folder

Are there any areas you would like me to focus on?
Anything and everything. I'm the sole developer on this and would love any feedback on file structure, code structure (including documentation/comments), test coverage I should be supplying, and overall intuitiveness of the code.

Have I reviewed this project previously?
Nope

• [ X] I agree for the code review to be public

Code Review - Connpy

What is the name of your project?
connpy

What is the repo URL?
https://github.com/fluzzi/connpy

Is there anything else I should know about the code?
This is a ssh/telnet connection manager + an automation tool, i'm not a programmer and this is my first.

Are there any areas you would like me to focus on?
Mainly the code readability, code structure, as I mentioned i'm not a programmer, i want it to be as clean as possible for the future.

Have I reviewed this project previously?
No

• [X ] I agree for the code review to be public

[Code Review Request] Stabilizer

What is the name of your project? Stabilizer

What is the repo URL? https://github.com/flowerpot-ai/stabilizer

Is there anything else I should know about the code?
We have been working on this project only since a month and I think its very advantageous to request for a code review at this early stage as we can pivot and adapt easily at this stage based on your suggestions. The project aims to provide Machine learning practitioners with tools to stabilize their Transformer model training.

Have I reviewed this project previously? No

• I agree for the code review to be public

Thank you very much for your help

[Code review request] Pydantic-Vault

What is the name of your project?
Pydantic-Vault

What is the repo URL?
https://github.com/nymous/pydantic-vault

Is there anything else I should know about the code?
I don't think so ^^ Hope the docs explain what it does, why it's helpful and how to use it

Are there any areas you would like me to focus on?
I had a lot of trouble thinking about the API to offer, and especially the priority of the different layers of configuration. Because the lib tries to be helpful in development and in production, it can be configured from environment variables or from the code. I am still not 100% certain of which should override the other if both the env variable and the code want to specify the config value, or which authentication method should win if multiple are found (like if I have a .vault-token locally but also happen to have an Approle ROLE_ID and SECRET_ID env variables defined).

Also, I'm not sure my logging and error handling is ok. Should I error out at the start if the vault_url is not defined, even though I don't error at all if I cannot login to Vault? Should the logs be info, warning... ? Is my way of logging even the correct way?

Also also, I'm not quite happy with the repetition in the _get_authenticated_vault_client and the various _extract_* methods 😅 I would like to make it easy to extend and provide other authentication methods (like Google Cloud, AWS, Azure, username/password... See the Vault docs for a full list of supported authentication methods).

Finally, are my tests any good? I mock a lot of things for now (about everything communicating with Vault through hvac), as setting up integration tests will be hard. It would need to run a Vault server, put some data in it, and maybe even run a Kubernetes cluster to make sure its authentication works (not even talking about the future integration with cloud providers...).

Have I reviewed this project previously?
No

• I agree for the code review to be public

Thank you for offering this service ❤️

[Code review] AI Chatbot Framework

What is the name of your project?
AI Chatbot Framework

What is the repo URL?
https://github.com/alfredfrancis/ai-chatbot-framework/

Is there anything else I should know about the code?
It loads ml models into memory during runtime

Are there any areas you would like me to focus on?

anything that you think would make the project more maintainable

Have I reviewed this project previously?
Noe

• I agree for the code review to be public

[Code Review Request] beaupy

What is the name of your project?
beaupy

What is the repo URL?
https://github.com/petereon/beaupy

Is there anything else I should know about the code?
It's a former fork of cutie that has taken its own life. It also uses rich 😉 .

Are there any areas you would like me to focus on?
General code quality and software design decisions. How overdue is a refactor?

Have I reviewed this project previously?
No

• I agree for the code review to be public

[Code review request] Minegauler (advanced minesweeper app)

What is the name of your project?
Minegauler

What is the repo URL?
https://github.com/LewisGaul/minegauler

Is there anything else I should know about the code?
There's lots I could write here - I've been working on this project since I was at uni learning Python and have started over a couple of times. I have a small design doc in the repo under https://github.com/LewisGaul/minegauler/blob/main/docs/, but if you'd like to ask/chat about anything just let me know.

This is a GUI app using PyQt5. I used this project to try out the MVC design pattern, but I feel I may have gone a bit overkill on abstracting the interaction between core and frontend.

Are there any areas you would like me to focus on?
The focus should be on the core minegauler package, not the stuff around the edge like the server/bot/helpers. I've just been trying to add a new 'split cells' mode (see LewisGaul/minegauler#41), and find myself trying to abstract the concept of a coordinate and the board, which has been quite tricky.

Have I reviewed this project previously?
No

• I agree for the code review to be public

Very kind of you to offer reviews for people! No worries if you don't want to spend time on mine, since the user count is fairly low and it's a desktop app rather than a library.

[Code Review Request] ics.py: iCalendar for Humans

What is the name of your project?
ics.py: iCalendar for Humans, a Pythonic and easy iCalendar library following RFC 5545

What is the repo URL?
https://github.com/ics-py/ics-py

Is there anything else I should know about the code?
We are about to complete a major rewrite of the library, whose details are documented here. Pretty much everything was re-built, while the user-facing API stayed mostly the same - which is good, but not really that important for a project with current version 0.8.0-dev. As most of that API grew organically, now would be the optimal point in time to think about which things we could do better in terms of usability.
The changes are close to complete for a alpha release (with the still missing documentation and test updates probably waiting until we release a beta version), while there still is some internal polishing and advanced, new functionality in the progress of being developed, where feedback in-the-loop would also be awesome (see also the discussion here).

Are there any areas you would like me to focus on?
There are a few areas that would benefit from a review:

• the user facing API, which mostly consists of attr.s classes for representing the individual iCalendar objects, which resides in the root code folder
• the (de-)serialization code, where most of the code resides in the converter module. The main idea is to automatically infer the required (de-)serialization steps by introspecting the attr.ibs of the data classes once after startup. I guess the architecture should be simplified in some places, as it's somewhat hard to convery an overview over interactions of the different classes that are involved, but I'm not quite sure how to do that without losing functionality. Furthermore, I'm planing to include new functionality for customizing the parsing by tweaking the handling of non-standard inputs and the resulting exceptions (allowing the user to silence them or replace misparsed values manually) and for adding parsers for custom properties, opinions on how this could achieved would be highly appreciated.
• what the library (and pretty much also no other library) currently can't handle properly, is recurring events. How the user facing API for this might look like is an interesting problem, altough also very closely tied to how the underlying RFC defines recurrance.

Have I reviewed this project previously?
Not that I'm aware of.

• I agree for the code review to be public

Request a review the code of the Patternshop project

Hello. @willmcgugan
Would it be possible to review the code of the Patternshop project (Patternshop is a tool to create textures for fabric design.)?
The idea is to redo this code to work on mac, windows and Linux without needing three versions, using qt (Python ).
I also think about implementing: I- support for .SVG and .XFC files.
II- cmyk support.
But first I need to know the bad and positive points of it. Because I want to know if it's worth investing.
Unfortunately the code language is in C++. : (
https://sourceforge.net/p/patternshop/code/HEAD/tree/

[Code Review Request] matmath

What is the name of your project?

• matmath (It is a python library for various matrix related operations)

What is the repo URL?

• https://github.com/Siddhesh-Agarwal/matmath

Is there anything else I should know about the code?

• it is preferably for python 3.6 and above (I think)

Are there any areas you would like me to focus on?

• Code readability and scope of project.

Have I reviewed this project previously?

• no

• I agree for the code review to be public

[Code Review Request] classyconf: Declarative and extensible library for configuration & code separation

What is the name of your project?
Classyconf

What is the repo URL?
https://github.com/hernantz/classyconf

Is there anything else I should know about the code?
No

Are there any areas you would like me to focus on?
I'm looking for recommendations on adding typing, since it really loads configuration from different sources, and I feel the typing is basically Any to Any...

Have I reviewed this project previously?
No

• I agree for the code review to be public

Code Review Request for `AwsIotCertificateGenerator`

What is the name of your project?
AwsIotCertificateGenerator

What is the repo URL?
https://github.com/f0xtek/AwsIotCertificateGenerator

Is there anything else I should know about the code?
Super simple project to automate the generation of AWS IoT Core certificates & keys.

Are there any areas you would like me to focus on?
Since it's a small project, mainly code readability, code structure and any ways to make the code more maintainable for future features.

Have I reviewed this project previously?
No

• I agree for the code review to be public

pip

What is the name of your project?
pip

What is the repo URL?
https://github.com/pypa/pip

Is there anything else I should know about the code?

There's about a decade of technical debt here. The two biggest chunks of complexity are the build logic and the dependency resolver.

There's some development docs in pip's documentation as well!

Are there any areas you would like me to focus on?

Well, I guess, if you can spot any easy wins like renaming things to clarify their purpose, or things that aren't consistent through the codebase! Stuff like that, but if you're down for a design review, that's welcome too. :)

Avoid looking too closely at the tests/lib directory and ignore the add_requirement method on InstallRequirement. The src/pip/_vendor directory has third-party packages that pip uses.

Is this your first review?

This question isn't super clear, but this would be the first time I'm filing an issue here.

PS: You might want to use GitHub issue forms here. ;)

• I agree for the code review to be public

`nbpreview`

What is the name of your project?

nbpreview

What is the repo URL?

https://github.com/paw-lu/nbpreview

Is there anything else I should know about the code?

Main purpose is to be a CLI that renders Jupyter Notebooks to the terminal. But also extends rich to render different notebook components (cells, DataFrame, images, graphs, etc) by making heavy use of the rich API—especially the console protocol—as almost everything is a class with a __rich__ or __rich_console__. Docs are essentailly non-existant at the moment.

Are there any areas you would like me to focus on?

Use of the rich API, general clarity and structure of the code. Priority is clarity over conciseness, performance, etc.

Have I reviewed this project previously?

No!

• I agree for the code review to be public

[Review request] openpiv-python

What is the name of your project?
openpiv-python

What is the repo URL?
https://github.com/OpenPIV/openpiv-python

Is there anything else I should know about the code?
it analyses images to estimate velocity of the flow: https://en.wikipedia.org/wiki/Particle_image_velocimetry

Are there any areas you would like me to focus on?
code clarity and performance
we basically want to make it better and we are not programmers, most of us trained as engineers

Have I reviewed this project previously?
Nope

• [ x] I agree for the code review to be public

[Code Review Request] BraillePy

What is the name of your project?
Braille as Python Module and BraillePy as repository

What is the repo URL?
https://github.com/UltraStudioLTD/BraillePy

Is there anything else I should know about the code?
If you use Python <3.5 then you must install "typing" module.

Are there any areas you would like me to focus on?
Will it be usable? I mean does it have any potential? Also is it possible to make it faster and more simpler?

Is this your first review?
Yes.

• I agree for the code review to be public

[Code Review Request] dr_scaffold

What is the name of your project?

dr_scaffold on GitHub and dr-scaffold package on PYPI, the name means Django REST Scaffold

What is the repo URL?

https://github.com/Abdenasser/dr_scaffold

Is there anything else I should know about the code?

The code is meant to be used with Django Rest Framework and uses Django management commands to add the new scaffold command.

For development you can copy dr_scaffold/dr_scaffold directly inside your Django project and add it to installed apps.

Are there any areas you would like me to focus on?

Mainly the generators.py which has the core functionality.

Is this your first review?

Technically yes.

• I agree for the code review to be public

Why r u doing this 4 free

Just curious to know, you showed up in my Google feed

Code review request for 0LL13/open_speech

What is the name of your project?
open_speech

What is the repo URL?
https://github.com/0LL13/open_speech

Is there anything else I should know about the code?
Thank you for your feedback!

Are there any areas you would like me to focus on?
For one legislature period there are some 3-4,000 speeches (in pdf) which I intend to convert to Speech class objects. I'm not sure about how to store them (dill?) and if I can integrate this into a web app.

Have I reviewed this project previously?
no

• I agree for the code review to be public
  yes

Code Review Request - Merlin Unchained

What is the name of your project?
Merlin Unchained

What is the repo URL?
https://github.com/automateyournetwork/merlin_unchained

Is there anything else I should know about the code?
I am only a few weeks in with Django and a few months in with Python
Everything 'works' but I am just wondering if as a novice / amateur coder if I am missing anything obvious / better ways

Are there any areas you would like me to focus on?
I am trying to use an "MVC" approach and I think I am doing "M" and "V" decently enough but I am not using enough "C" - maybe focus on my use of the controller?

Have I reviewed this project previously?
No

• [ X ] I agree for the code review to be public

Code review request for `reviews`

What is the name of your project?
Reviews

Summary of the project: https://www.reddit.com/r/Python/comments/ncvxqn/reviews_a_tui_for_monitoring_code_review_requests/

What is the repo URL?
https://github.com/apoclyps/reviews

Is there anything else I should know about the code?

The solution was originally developed on a much earlier version of Rich during a POC hackathon - some of the original design remains which may not be idiomatic.

Are there any areas you would like me to focus on?
Improving usage of rich - with a focus on the view generated by the dashboard command.

Have I reviewed this project previously?
No

• I agree for the code review to be public

[Code review request] dry-python/classes

What is the name of your project? dry-python/classes

What is the repo URL? https://github.com/dry-python/classes/

Is there anything else I should know about the code? It is typed by a quite complex mypy plugin, don't be confused with our strange annotations, they are valid 🙂

Are there any areas you would like me to focus on? Docs, newcomer friendlines, examples

Is this your first review? Yes ➕

• I agree for the code review to be public

[Code Review Request] Mealie - Recipe Manager

What is the name of your project?
Mealie

What is the repo URL?
https://github.com/hay-kot/mealie/tree/mealie-next

Is there anything else I should know about the code?
Note that the branch mealie-next differs greatly from the master branch. Please review mealie-next. I'm working through a pretty thorough re-write at the moment to make the code more maintainable. Feel free to review anything in the code base that you please, but the items below are my main concern.

Are there any areas you would like me to focus on?
The biggest thing I'd love to get another pair of eyes on is the HttpService class and RouterFactory that I'm using to base services off of. The BaseHttpService class contains the base code I'm using to build other services that are used throughout the life-cycle of a request. There are some utility methods and some abstract methods that are implemented by child classes.

I'm using these base classes in conjunction with a CrudHttpMixin class that contains some common functionality for CRUD operations. The WebhookService shows the most basic implementation of inheriting from both classes.

To establish routes, I feed them into a RouterFactory class that returns an APIRouter with the CRUD routes populated from their definitions on the class. You can see an example of use with the WebhooksSevice here

Part of me feels like I'm taking the best parts of C# API Design in shoving them into FastAPI and the other part of me feels like I'm creating too much cohesion between classes and am going to regret this later.

Any insight or recommendations you have would be greatly appreciated.

Have I reviewed this project previously?
No

• I agree for the code review to be public

Code review for `marker`

What is the name of your project?
marker

What is the repo URL?
https://github.com/mustafaquraish/marker

Is there anything else I should know about the code?

Are there any areas you would like me to focus on?
General API design, I'd like to have different interfaces to use the same core code, for instance I have a CLI with rich+cmd2, and a web-interface (link for reference). Currently a lot of the interface between the core code and the "frontend" is done through the console class defined in my code, which seems very hacky.

Have I reviewed this project previously?
No

• I agree for the code review to be public

The Open Data Cube

What is the name of your project?

The Open Data Cube, the project on GitHub is datacube-core. It's an OSGeo Community Project.

What is the repo URL?

datacube-core

Is there anything else I should know about the code?

It's used to manage a postgres index to millions of Earth observation images, including the management of the index itself and the loading of the data into memory.

Are there any areas you would like me to focus on?

Nothing specific.

Is this your first review?

I think so!

• I agree for the code review to be public

[Code Review] NServer

What is the name of your project?
NServer

What is the repo URL?
https://github.com/nhairs/nserver

Is there anything else I should know about the code?
No. Hopefully any questions you have when getting started are readily available from the README and DESIGN_NOTES.

Are there any areas you would like me to focus on?
It's a framework, so mostly interested in API design. That said, there has been no other code review and it's a pretty small project so any feedback on any areas is appreciated 🙏.

If you have any domain specific knowledge that you think would be useful always welcome.

Have I reviewed this project previously?
No

• I agree for the code review to be public

Also, this project is a great idea and a great way to give back to the open-source community so regardless of looking at any of my projects, thank you for your time!

[code review] django-watchman

What is the name of your project?

django-watchman

What is the repo URL?

https://github.com/mwarkentin/django-watchman

Is there anything else I should know about the code?

Are there any areas you would like me to focus on?

Checks.py, decorators.py, views.py

Have I reviewed this project previously?

No

• I agree for the code review to be public

[Code Review Request] Hyperledger Cactus

What is the name of your project?

Hyperledger Cactus

What is the repo URL?

https://github.com/hyperledger/cactus

Is there anything else I should know about the code?

It's written in Typescript, so if you only accept Python-only repos this is not a good fit, apologies.

Are there any areas you would like me to focus on?

The ledger connector classes and the plugin architecture (it's a monorepo).
Packages such as:

• cactus-core-api
• cactus-plugin-ledger-connector-*

Have I reviewed this project previously?

No

• I agree for the code review to be public

[ Code Review Request ] Glass

What is the name of your project?
Glass

What is the repo URL?

https://github.com/Horlarwumhe/glass

Is there anything else I should know about the code?

Glass is a WSGI routing library,( I call it this and not web framework because it doesn’t have some core tools for backend web development). It comes with template engine (similar to django template ).

Are there any areas you would like me to focus on?
No particular area. Want a thoroughly review

Have I reviewed this project previously?
No

• I agree for the code review to be public

SyntaxAutoFix

What is the name of your project?
SyntaxAutoFix

What is the repo URL?
https://github.com/Mte90/SyntaxAutoFix

Is there anything else I should know about the code?

Are there any areas you would like me to focus on?

Have I reviewed this project previously?
No

• I agree for the code review to be public

[Code Review Request] RocketPy

What is the name of your project?
RocketPy

What is the repo URL?
https://github.com/Projeto-Jupiter/RocketPy/

Is there anything else I should know about the code?
It is an open-source rocket trajectory simulation code used by universities around the world.

Are there any areas you would like me to focus on?
Specially maintainability.

Have I reviewed this project previously?
No.

• I agree for the code review to be public

[Code Review Request] ActivityWatch

What is the name of your project?

ActivityWatch

What is the repo URL?

https://github.com/ActivityWatch/activitywatch

Is there anything else I should know about the code?

The linked repo is the "bundle repo" which includes several modules (server, clients) as git submodules. Architecture described in the docs: https://docs.activitywatch.net

Are there any areas you would like me to focus on?

Security. We offer bounties for finding vulnerabilities!

Have I reviewed this project previously?

No.

• I agree for the code review to be public

GH-License

What is the name of your project?
GH-License

What is the repo URL?
https://github.com/Mte90/GH-License

Is there anything else I should know about the code?

Are there any areas you would like me to focus on?

Have I reviewed this project previously?
No

• I agree for the code review to be public

[Code Review Request] BusyLight for Humans™

What is the name of your project?

BusyLight for Humans™

What is the repo URL?
https://github.com/JnyJny/busylight

Is there anything else I should know about the code?
This project provides access to USB connected presence lights from multiple vendors. It attempts to put a common interface in front of different lights with their varying capabilities.

The test cases run regardless of the presence or absence of a light.

Are there any areas you would like me to focus on?

• The ABC class busylight.lights.usblight.USBLight and concrete implementations
• The threading model is sort of a hack. Some lights need active management so a thread is necessary.
• The Manager class busylight.manager.Manager is pretty raw
• The web API is rudimentary at best :)

Have I reviewed this project previously?
No

• I agree for the code review to be public

Thank you for your time!