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

Introduce Poetry and docker compose #34

Merged

Conversation

K-dash
Copy link
Collaborator

@K-dash K-dash commented May 30, 2024

@ryansurf
Please check the PR for #32 first!

I've introduced Poetry:)
ae931c6

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

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!
8d2efaf

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
d62a73a

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...

K-dash added 8 commits May 30, 2024 12:32
- Add pyproject.toml and poetry.lock files for managing dependencies with Poetry
- Remove requirements.txt as it is no longer needed due to Poetry integration
- Update CI configuration files to work with Poetry instead of requirements.txt
- Update import statements in files under the src directory to use consistent paths
- Poetry's introduction allows for better recognition of the project root path
- Simplify and standardize import paths throughout the codebase
- Install Poetry within the Docker container
- Add docker-compose.yml file to simplify application setup and development
  - Allow users to easily start the application without installing Poetry locally
@ryansurf
Copy link
Owner

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 😂, I appreciate it!

@ryansurf ryansurf merged commit 42a7173 into ryansurf:main May 30, 2024
2 checks passed
@K-dash
Copy link
Collaborator Author

K-dash commented May 31, 2024

@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 :)

@K-dash K-dash deleted the feature/introduce-poetry-and-docker-compose branch May 31, 2024 04:57
@ryansurf
Copy link
Owner

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

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.

2 participants