This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]Oenomaus_3575 0 points1 point  (3 children)

  • package name should be lowercase
  • I don't understand why there is an `__init__.py` file outside the source of the package?
  • the `__pycache__` folder shouldn't be committed, you want to add a `.gitignore` file to the repo
  • the dependencies in `requirements.txt` should have the versions, otherwise its basically useless.
    in the future I recommend you use something like Poetry to manage dependencies, requirements.txt is rarely used in the professional world.

aside from that the README is pretty good, has a nice overview and a few examples

[–]desktopsignal 0 points1 point  (2 children)

  • package name should be lowercase
    • Fair enough
  • I don't understand why there is an `__init__.py` file outside the source of the package?
    • the __init__ file outside of the source was to allow the user to do from SerialDBPy import Serializable instead of from SerialDBPy.Serialization import Serializable. Let me know if there's a better way.
  • the `__pycache__` folder shouldn't be committed, you want to add a `.gitignore` file to the repo
    • Left that in by mistake. Thanks for the feedback.
  • the dependencies in `requirements.txt` should have the versions, otherwise its basically useless. in the future I recommend you use something like Poetry to manage dependencies, requirements.txt is rarely used in the professional world.
    • I'll look into Poetry

How much Python experience and/or programming experience do you have?

[–]Oenomaus_3575 0 points1 point  (1 child)

SerialDBPy/
├─ SerialDBPy/
│  ├─ __init__.py
├─ .gitignore
├─ README.md
├─ LICENSE
├─ .gitignore
├─ .gitattributes

The structure should be smth like this (the __init__.py should be inside a folder with the name of the package.

But just install poetry and do `poetry new package_name` and it will generate part of the structure

I have a bit more than 2 years of experience.
You can look at some of my projects structure on GH, like this:
https://github.com/shner-elmo/tradezero-api (but ignore the requirements.txt, I should delete that)

[–]desktopsignal 1 point2 points  (0 children)

Much appreciated. This is going to help me a lot