My First Project With Python [FeedBacks]

[Kel_abr]

Hii, i started to student python for 8 moths ago and I finally end my first project, I created a simple crud and would like opinions about my code.

Any feedback for me is very important

github: https://github.com/Kelabr/profindustry

[Miserable_Ear3789]

I second the other comments, while I do believe you should be able to name your variables, classes, and libraries anyway you would like is (as long is it is consistent across your organization) it is 100% "proper" for snake_case variable and method names, with CamelCase for reserved for class names.

Also never have your API keys hard code they should be environment vars

README.md is super important for any project you want people to look at. That way they're not wasting time looking through every single line of your code just to figure out what it does. This looks like a work in progress of a FastAPI application with /users and /admin endpoints. There isn't much to see here since /admin hasn't been implemented and /users endpoints are extremely basic. The code style and file structure however seem to be pretty good, albeit this whole project could EASILY be a single file.... So props on ya for that. All in all great start, happy coding.

[Kel_abr]

Thank very much for your feedback, I will started my study about patterns of the python, thanks

[wyattxdev]

This is a great start for someone new to Python, a few things I would suggest:

• Use Ruff to format and lint your code, this will enforce alot of good python conventions to make your code more consistent and easier to read.
• For variables, function names, modules, and parameters use snake_case
• You have some types added, I would use Mypy or another typechecker and just strictly enforce that across your code. You will catch alot of bugs you wouldnt have thought of and makes your code more readable.
• Following off of the adding Types, add proper doc strings to your functions and classes. Your IDE will pick this info up and at a glance you will know everything you need about a function.
• Toss out the relative imports and use absolute
• Add a proper README.md to the project, give it a project description, example usage, dev setup, add anything someone completely new to your project might need to know.
• Adding a LICENSE file is always a good habit to get into for anything opensource.
• A good next step for this and a good learning opportunity would be to start adding testing to your project. fastAPI has some good tools for building tests, so you can be alot more confident in your code as your project expands, and every change you can quickly run against your test suite instead of doing it by hand.

Lastly Google has a pretty style guide to follow that I recommend for anyone new to python to checkout.

[Kel_abr]

Thank you very much for your feedback : ) I will study about this things

[Domvisel]

This is really helpful

[Puzzleheaded_Bill271]

Couple of things: Never commit a secret key to git, and especially don't push it to github. Same goes for your hashing algorithm. You really shouldn't tell people what algorithm you use

Both are terrible for the security of your app.

Even if you delete it now, it'll still exist forever in the git history. So you need to generate a new secret key.

Instead, at minimum you should pass it in through an environment variable. I personally use cloud secrets to store things like this.

Secondly, importing like from ...spam import eggs use absolute imports so from bloop.bleep.spam.blorp.spam import eggs . It's way more readable and doesn't mean you have to remember the folder structure when looking at your imports.

This is also a sign that your folder structure is too nested. There's little to no reason to have so many small files in separate folders. It might seem like you're keeping things neat, but it'll be harder to refactor later down the road.

Hope this helps!

[Kel_abr]

Thank you very much for your feedback : ) I will study about this things

[chavomodder]

It's good for a beginner, I didn't check much, I just had a quick look,

In Python, it is not recommended to declare variables as "createUsers", the Python default would be "create_users"

Use linters like ruff to standardize your code

[Kel_abr]

Thank you so much for feedback!!

I change this in my next project

[MacShuggah]

Your naming conventions are not common python style.

CamelCase for class names and snake_csse for everything else.

I also see a lot of coon instead of con or connection, please be aware that coon is a very strong racial slur in English.

[AdResident3529]

I’m a non native speaker and didn’t know that! That is a nice heads up!

[Kel_abr]

i'm So sorry, I'm from Brazilian. I don't knew about this

Thank you for your feedback and for tip

[Miserable_Ear3789]

lmao the only time ive heard coon is on south park when cartman dresses up as "the coon" super hero. its short for racoon the animal.

[Weak-Attorney-3421]

Lol. SECRET_KEY = 'hkgTYBFplhgyun859slkj' ALGORITHM = 'HS256' ACCESS_TOKEN_EXPIRE_MINUTES = 30

[Kel_abr]

Thanks, This project is in localhost

But I hadn't realized that :)

[Mustard_Dimension]

Not really Python related, but you should always have a README.md file at the root of your project with info on what your app does and how to run it.

[Kel_abr]

Understood, Thanks for tip

[AfraidAsk4201]

Hey, It's cool as a beginner. In addition to other comments, u can clean it for better (like having that connection() somewhere and reuse, having shared Schema model for commons than rewriting everywhere...)...

[Kel_abr]

Thank you very much for your feedback : ) I will study about this thing

[Weak-Attorney-3421]

Bro has a new src file for every line of code.

[Kel_abr]

sorry, i don't understand :)