Setting Up a Python Dev Environment with DevContainers and Daytona

[Kiran1689]

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

• Use CTRL+F to search for relevant keywords in:
  • Daytona Dotfiles Sitemap
  • Daytona Definitions Sitemap
• Interlink keywords using the appropriate URLs.

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.

[Kiran1689]

@mojafa Can you please review?

[mojafa]

Slight spacing issue here:

[mojafa]

@Kiran1689 your guide works.

fix the requests then we can merge.

[Kiran1689]

Slight spacing issue here:

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

[mojafa]

@Kiran1689 Here:

[Kiran1689]

updated @mojafa

[Kiran1689]

Anything else @mojafa ??

[mojafa]

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

[mojafa]

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

[Kiran1689]

@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]

@nkkko @mojafa Can you please look into this

[Kiran1689]

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

[Kiran1689]

@mojafa Can you check this

[mojafa]

@Kiran1689 on it

[mojafa]

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

[Kiran1689]

@nkkko Can you please look into this?

[nkkko]

Code!

[nkkko]

@mojafa please take more attention, notes should be removed

[nkkko]

Check the right way of writing Dev Container not DevContainer

[nkkko]

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

[Kiran1689]

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

[Kiran1689]

@nkkko 👀

[mojafa]

Will rereview

[mojafa]

@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]

@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

[Kiran1689]

@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]

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

[mojafa]

@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]

@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 *).

[Kiran1689]

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

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

[Kiran1689]

@mojafa Now it's passing all checks, waiting for your approval..

[mojafa]

@Kiran1689 here's my feedback:

Terminology Corrections:

"DevContainer" vs. "Dev Container": The correct term is "Dev Container." Please update all instances of "DevContainer" to "Dev Container" throughout the article to maintain accuracy.

Spacing Around Links:
There are several instances where spacing is missing around links, such as in the prerequisites section:
Incorrect: Basic understanding of[Python](definitions/20240820_defintion_python.md)
Correct: Basic understanding of [Python](definitions/20240820_defintion_python.md)

Lack of Detailed Instructions:
The article introduces setting up a Python development environment using Dev Containers and Daytona but lacks in-depth, technical guidance.

Example: Sections like "## Step 1: Preparations" and "### Fork the Template Repository" are brief and do not provide enough detailed steps for a reader to follow effectively.

Recommendation: Consider following a structure similar to https://www.daytona.io/dotfiles/the-ultimate-guide-to-managing-python-environments . This guide offers detailed, step-by-step instructions that would greatly benefit readers.

Incomplete Steps: In "### Step 3: Confirmation," the instructions are vague:
"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."
Action Item: Provide explicit instructions on how to run the test cases in VS Code. Include screenshots, commands, or code snippets as necessary to guide the reader.

Rework Section Headings: The current headings like "## Step 1: Preparations" can be made more descriptive. For example:

"## Step 1: Setting Up Your Development Environment"
"### Cloning the Template Repository"
Flow of Content: Ensure that each section logically leads to the next, providing a smooth journey for the reader from start to finish.

[mojafa]

you could use this merged PR as inspiration: https://github.com/daytonaio/content/pull/85/files

I'd also suggest, you let users create a new repo and then guide them on it step by step.

[mojafa]

Good stuff so far, you just picked a short cut, it's a guide, take your time and be very technical as it's a technical guide.

[Kiran1689]

Hey @mojafa
Always check the latest code/files before review.

You are reviewing the old files..

Check here always for the latest committed
https://github.com/daytonaio/content/pull/120/files

Most of them are already fixed..

[Kiran1689]

you let users create a new repo and then guide them on it step by step.

I'll work on this

[mojafa]

Hey @Kiran1689

I created a new workspace by using daytona create https://github.com/daytonaio/content/pull/120
This will fetch your PR with it's latest changes.

Interestingly I'm still seeing the same stuff.

See below:

[Kiran1689]

@mojafa Check this

• Added repository setup for step by step guide

If you are not able to see the latest changes in workspace, check here

[mojafa]

@Kiran1689 This is what I'm talking about now.

The guide is comprehensive and covers all the points. Thank you.

And of course the code works...

[Kiran1689]

@mojafa can you please provide your approval if everything is good..

[Kiran1689]

@nkkko Can you please check this?

[mojafa]

@Kiran1689 please be patient