Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor clean up #52

Merged
merged 4 commits into from
Jun 15, 2023
Merged

Minor clean up #52

merged 4 commits into from
Jun 15, 2023

Conversation

patillacode
Copy link
Collaborator

Hi @AntonOsika

I decided to apply a minor clean up and add a few details for the near future.

  • I have pinned the requirements for now until we decide on a better approach to handle dependencies (I suggest pip-tools)

  • I have added a pyproject.toml file that contains ruff and black configurations, I believe that having these can help us maintain a cleaner codebase. (notice I have ran black and ruff on the existing codebase, no functionality has been changed)

  • I have updated the .gitignore file, I have kept it minimal for now.

For the near future I was thinking a few tasks I can do, of course these are just suggestions, let me know your thoughts:

  • write a proper Makefile for easier installation/run.
  • setup pip-tools
  • setup pre-commit hooks to enforce the use of ruff and black

@AntonOsika
Copy link
Owner

Merging!

As for Makefile, what would it do for us today?

pre-commit: Yes! Sounds great.

pip-tools: I mentioned this in #Looks good!

I just would like to merge #38, what does it do for us today?

@AntonOsika AntonOsika merged commit 3538a4c into AntonOsika:main Jun 15, 2023
@patillacode
Copy link
Collaborator Author

Makefiles are usually a nice tool to abstract the commands a bit, for example, a classic way of using it is to create an install command that would create the venv and install the dependencies in requirements.txt
so a user can potentially clone the repo, run make install and good to go.

We could add another command for example make start or make run, etc.

At the moment maybe we don't have many things to do besides "run the app" but a makefile could come in handy in the near future.

I read your comment regarding pip-tools in #38 let's keep it simple for now, classic requirements.txt will work, we only have a few dependencies.

I'll create the issue for the pre-commit setup and assign to myself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants