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

Setting Up a Python Dev Environment with DevContainers and Daytona #120

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

Kiran1689
Copy link
Contributor

@Kiran1689 Kiran1689 commented Nov 21, 2024

fix #10
/claim #10

Writer's Checklist

Writing Structure

  • Use short sentences and paragraphs, and include bucket brigades.
  • Include more than two descriptive H2 headings to organize content.
  • Capitalize headings according to the AP Stylebook (use this tool)
  • Include an introduction with at least two paragraphs before the first H2 section.
  • Use appropriate formatting (bold, italic, underline), notes, quotes, TLDRs, and key points.
  • Incorporate code elements and Markdown format where appropriate.
  • Ensure at least one visual element per “screen” of the article (screenshots, diagrams, tables, graphs, lists, sidenotes, blockquotes).

Fact-Checking

  • Verify all facts and data points included in the article.

Asset Management

  • Save images in the /assets folder.
  • Follow naming conventions: YYYYMMDD_title_of_the_article_IMG_NAME_NO.png.
  • (Optional) Create a GitHub repo for the code referenced in the article and share it.
  • (Optional) Include a link to this Loom video in the PR comments.

Interlinking

Glossary/Definitions

  • Create new definition in /defitnitions folder.

Review and Edit

  • Ensure articles address the needs of the target audience and their search intent.
  • Read the article out loud to catch any awkward phrasing.
  • Run the draft through Grammarly or a similar grammar tool.
  • Double-check adherence to the style guide and repository guidelines.
  • Use the name of the article for the title of the PR.

Signed-off-by: Kiran1689 <[email protected]>
@Kiran1689
Copy link
Contributor Author

@mojafa Can you please review?

Signed-off-by: Kiran1689 <[email protected]>
@mojafa
Copy link
Collaborator

mojafa commented Nov 21, 2024

Slight spacing issue here:
Uploading Screenshot 2024-11-21 at 21.33.12.png…

@mojafa
Copy link
Collaborator

mojafa commented Nov 21, 2024

@Kiran1689 your guide works.

fix the requests then we can merge.

Screenshot 2024-11-21 at 21 50 29

@Kiran1689
Copy link
Contributor Author

Slight spacing issue here:

@mojafa The image is not showing for the issue can you please reshare

@mojafa
Copy link
Collaborator

mojafa commented Nov 21, 2024

@Kiran1689 Here:
Screenshot 2024-11-21 at 21 33 12

Signed-off-by: Kiran1689 <[email protected]>
@Kiran1689
Copy link
Contributor Author

updated @mojafa

@Kiran1689
Copy link
Contributor Author

Anything else @mojafa ??

@mojafa
Copy link
Collaborator

mojafa commented Nov 21, 2024

@Kiran1689 sorry I think my previous comments hadn't gone through.
I noticed this PR has content from your other issue attempts. Please clean up the project, remove any other issue attemps and only have this guide in your guides section as well as all the assets.

see below.

Screenshot 2024-11-21 at 22 46 50

@mojafa
Copy link
Collaborator

mojafa commented Nov 21, 2024

only have this guide and the template as well as the assets, including author section as well

@Kiran1689
Copy link
Contributor Author

Kiran1689 commented Nov 21, 2024

@mojafa Sorry, I didn't get that.

What I need to remove? Can you please tell

My branch is up to date with the main branch.. As the main repo already contains my author details, I didn't add to this PR again.

This PR only has a guide file for issue #10 and assets related to it. No other guide files.. My other contributions are already merged into the main branch.

@Kiran1689
Copy link
Contributor Author

@nkkko @mojafa Can you please look into this

@Kiran1689
Copy link
Contributor Author

@mojafa You can check the files added for this PR here - https://github.com/daytonaio/content/pull/120/files

This PR contains only files related to the issue, no other contribution files.

image

@Kiran1689
Copy link
Contributor Author

@mojafa Can you check this

@mojafa
Copy link
Collaborator

mojafa commented Nov 25, 2024

@Kiran1689 on it

@mojafa
Copy link
Collaborator

mojafa commented Nov 25, 2024

@nkkko PR meets all requirements but is failing on content complaince

@Kiran1689
Copy link
Contributor Author

@nkkko Can you please look into this?

Now, your python dev environmentis ready to use.

### Step 3: Confirmation
Now, In your VS code run the test cases, you will see all the testcases passed. This means python dev environment has successfull set for your project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code!

- [Daytona Documentation](https://www.daytona.io/dotfiles/the-ultimate-guide-to-managing-python-environments)


<!-- Note on Definitions -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mojafa please take more attention, notes should be removed

![Daytona workspace](assets/setting_up_a_python_dev_environment_with_devcontainers_and_daytona_img10.png)

## Conclusion
By following this guide, you've set up a fully containerized Python development environment using Daytona and DevContainers. This setup ensures that your projects are reproducible, isolated, and consistent across machines, enabling smooth collaboration and effortless debugging.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check the right way of writing Dev Container not DevContainer

@nkkko
Copy link
Member

nkkko commented Nov 26, 2024

@mojafa this doesn't read 100% well, there are still some small things you should have caught 😁
@Kiran1689 please reread it at least 3 times and fix small things, also please check some of the posts on our blog before that as it could just give you some inspiration to improve it just a bit. Thanks for your understanding and effort.

Signed-off-by: Kiran1689 <[email protected]>
@Kiran1689
Copy link
Contributor Author

@mojafa @nkkko I have updated the content and made changes accordingly..

@Kiran1689
Copy link
Contributor Author

@nkkko 👀

@mojafa
Copy link
Collaborator

mojafa commented Nov 28, 2024

Will rereview

@mojafa
Copy link
Collaborator

mojafa commented Nov 29, 2024

@Kiran1689 quite a lot of DevContainer all over and you still have notes in your file.

It's still failing on compliance checks.
Also check this

  • Change unordered list styles (MD004): Replace * with - for unordered lists if the style is set to "dash".
  • Line length violations (MD013): Break long lines into shorter ones (70 characters or as specified).
  • Correct heading levels (MD001, MD002): Ensure headings increment by only one level at a time and that the first heading is h1 as such ## Subheading`` ### Fixed levels not `## Subheading`` #### Fixed levels
  • Surround headings with blank lines (MD022): Add a blank line above and below each heading.
  • No duplicate headings (MD024): Ensure all headings have unique content.
  • Fix hard tabs (MD010): Replace tabs with spaces.

@mojafa
Copy link
Collaborator

mojafa commented Nov 29, 2024

@Kiran1689 please refer to the issue again.

Daytona as endgame Python dev env. how to skip all env managers like venv, etc. and just use Daytona.

Explore the benefits of using DevContainers for Python development and how to set them up step by step. You can use a provided reference repo, or create a new one with some specific spin, etc.

Use this link for inspiration: https://www.daytona.io/dotfiles/the-ultimate-guide-to-managing-python-environments

Signed-off-by: Kiran1689 <[email protected]>
Signed-off-by: Kiran1689 <[email protected]>
@Kiran1689
Copy link
Contributor Author

@mojafa

  • I have removed the notes and replaced DevContainer with Dev Container all over the article except in image name and file name
  • fixed the lint issues in the guide as you mentioned but still its failing bcs of issues in all other files

@Kiran1689
Copy link
Contributor Author

@mojafa @nkkko Can you please look into this as well?

@mojafa
Copy link
Collaborator

mojafa commented Dec 2, 2024

Screenshot 2024-12-02 at 19 08 43
@Kiran1689 as i figure out where your PR falls short on the Content Compliance Check, please check your guide for spelling and cohesion, use grammarly or hemingways, Like that should be has successfully or was successful

@mojafa
Copy link
Collaborator

mojafa commented Dec 2, 2024

@Kiran1689 also please run:
npm install -g markdownlint-cli and then npx markdownlint "/*.md"** to see where your Content Compliance Checks are failing.

but mostly here:
Heading Structure Errors

  • MD025/single-title/single-h1: Multiple top-level (H1) headings in the same document.
  • MD041/first-line-heading/first-line-h1: The first line in a file should be a top-level heading (H1).
  • MD022/blanks-around-headings: Headings should be surrounded by blank lines.
  • MD036/no-emphasis-as-heading: Emphasis (bold or italic) used instead of a proper heading.
  • MD023/heading-start-left: Headings must start at the beginning of the line.

Formatting and Style Errors

  • MD009/no-trailing-spaces: Trailing spaces at the end of lines.
  • MD012/no-multiple-blanks: Multiple consecutive blank lines; typically, only one blank line is expected.
  • MD004/ul-style: Unordered list style inconsistency (e.g., using asterisks * instead of dashes -).
  • MD007/ul-indent: Incorrect indentation for unordered lists.
  • MD010/no-hard-tabs: Hard tabs (\t) used instead of spaces.
  • MD034/no-bare-urls: Bare URLs used without proper formatting.
  • MD038/no-space-in-code: Spaces inside inline code spans.
  • MD029/ol-prefix: Incorrect ordered list item prefix.
  • MD039/no-space-in-links: Spaces inside link text.
  • MD049/emphasis-style: Inconsistent emphasis style (e.g., mixing underscores _ and asterisks *).

Signed-off-by: Kiran1689 <[email protected]>
Signed-off-by: Kiran1689 <[email protected]>
Signed-off-by: Kiran1689 <[email protected]>
Signed-off-by: Kiran1689 <[email protected]>
@Kiran1689
Copy link
Contributor Author

Kiran1689 commented Dec 3, 2024

@mojafa, I've updated the content to correct grammar and spelling mistakes and resolved all lint issues in my guide. However, it’s still failing due to lint issues in other files, including node modules. Can't fix that.

VirtualBox_u-22_03_12_2024_17_36_57

I noticed that all other PRs are failing the Content Compliance Check.

Signed-off-by: Kiran1689 <[email protected]>
@Kiran1689 Kiran1689 requested a review from nkkko December 3, 2024 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Setting Up a Python Dev Environment with DevContainers and Daytona
3 participants