search

ryansurf / cli-surf

Get surf and ocean data from the command line interface
7 stars 10 forks source link

Introduce Poetry and docker compose #34

Closed K-dash closed 1 month ago

K-dash commented 1 month ago

@ryansurf Please check the PR for #32 first!

I've introduced Poetry:) ae931c6c3e0807caa004b2534935712316fe695e

And the relative import thing I mentioned here has been resolved. 06e36b3dccbe785511113181f067ca05c5be8d13

I also thought I'd recommend using Docker to launch it for users who don't want to use Poetry, and I've installed Docker Compose to make it easy to launch containers! 8d2efaf8df5f20a2f7f7f6d2914d4fadf9ba9e03

Docker Compose allows you to develop with it, so eventually you may want to consolidate to containers.

Finally, the usage of Poetry and Docker Compose is reflected in README.md and CONTRIBUTING.md d62a73a6ceb3dcc38332151a063633029a1bee0a

I have checked that it works fine with what is written, but just to be sure, please check it in your environment as well!

Sorry for the amount of changes...

ryansurf commented 1 month ago

Tested the changes on my local, everything works! The relative import issue was quite annoying, thank you for getting on that.

The makefile you've created is perfect, everything is so simple to get up and going now.

By this: Docker Compose allows you to develop with it, so eventually you may want to consolidate to containers., do you mean that we should package all dev tools in containers eventually so all dev can take place there? Maybe my question didn't make sense, can you elaborate on this one a little?

The documentation you wrote is great, I used it when testing the changes on my local and it went smoothly.

You've been doing some great work, thank you all the changes you've made. I wouldn't have thought of most of these things on my own :joy:, I appreciate it!

K-dash commented 1 month ago

@ryansurf Hey, Thanks a bunch for accepting my PR! I'm really glad to hear that it was helpful.

By this: Docker Compose allows you to develop with it, so eventually you may want to consolidate to containers., do you mean that we should package all dev tools in containers eventually so all dev can take place there? Maybe my question didn't make sense, can you elaborate on this one a little?

Sorry, my explanation was a bit lacking.

When it comes to developing with Docker Compose, all the development tools (like Poetry) are installed inside the container. This means you can hop into the container, directly edit the files within, and get your development groove on. The best part? Your local development environment stays squeaky clean! Take Visual Studio Code, for example. It's a super popular IDE that has this awesome extension called Remote Containers. With this handy tool, you can connect to a container fired up by VScode and work your magic on the files inside. It's like having the full local development experience, but without the clutter!

You might already be familiar with Remote Containers, but if you haven't tried it out yet, I totally recommend giving it a spin :)

ryansurf commented 1 month ago

I see, I was not familiar with remote containers. Might be the move honestly, I started messing around with Docker a few months ago and haven't looked back. Thanks for explaining