{"id":26658937,"url":"https://github.com/denisecase/streaming-01-getting-started","last_synced_at":"2025-04-11T14:09:41.202Z","repository":{"id":97698717,"uuid":"584758620","full_name":"denisecase/streaming-01-getting-started","owner":"denisecase","description":"An opinionated way to get started with Python for streaming analytics","archived":false,"fork":false,"pushed_at":"2024-04-24T14:05:52.000Z","size":385,"stargazers_count":0,"open_issues_count":0,"forks_count":109,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-25T10:17:15.476Z","etag":null,"topics":["beginner","git","markdown","python","streaming-analytics","vscode"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/denisecase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-01-03T12:50:43.000Z","updated_at":"2024-06-05T18:20:49.000Z","dependencies_parsed_at":"2024-04-24T15:30:52.934Z","dependency_job_id":"5c29e356-879e-4f6b-844b-d0fd2b467296","html_url":"https://github.com/denisecase/streaming-01-getting-started","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denisecase%2Fstreaming-01-getting-started","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denisecase%2Fstreaming-01-getting-started/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denisecase%2Fstreaming-01-getting-started/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denisecase%2Fstreaming-01-getting-started/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/denisecase","download_url":"https://codeload.github.com/denisecase/streaming-01-getting-started/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248413725,"owners_count":21099349,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["beginner","git","markdown","python","streaming-analytics","vscode"],"created_at":"2025-03-25T10:17:19.620Z","updated_at":"2025-04-11T14:09:41.174Z","avatar_url":"https://github.com/denisecase.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# streaming-01-getting-started\n\n\u003e Get started with Python for streaming analytics\n\nWe assume no prior programming experience and that you want to \nget productive as quickly as possible.\n\nThis project uses only content from the Python Standard Library. \nNo project virtual environment is required. \n\nThese are popular industry tools - we'll practice with them a lot. \nGetting good at them helps you build better analytics projects more efficiently. \n\n## Prerequisites\n\nYou should have these downloaded and installed on your machine:\n\n1. Python 3.10 or higher\n1. VS Code\n1. VS Code Extension: Python\n1. Git (configured with user.name and user.email - the same email you use for GitHub)\n\nRemember:\n\n- **Spacing, Spelling, Capitalization**: When programming, these are critical. Always double-check!\n\n---\n\n## Open Project Folder in VS Code\n\nIn VS Code, open just your project repository folder, e.g. Documents/streaming-01-getting-started.\n\n## Verify Installations / Update Default Python\n\nIn VS Code, open a terminal window (View / Terminal) and verify your software is installed and configured.\n\n- If Mac/Linux, the default terminal should work.\n- If Windows, be sure you're using a PowerShell terminal (rather than cmd).\n\nImportant: \n\n- If Mac/Linux, change `python` to `python3` in the commands below.\n- In Windows, you might try `py` instead of `python`.\n- Type each command rather than copy \u0026 paste for best results. \n- Wait for each command to complete before running the next command.\n\n```shell\ngit --version\ngit config user.name\ngit config user.email\npython --version\npython -m pip install --upgrade pip wheel\n```\n\n✔️ Make sure all commands complete successfully. \nIf not, post your screenshots and the text of the error message in the discussion.\nThey all must run successfully before continuing.\n\n## Execute Utility Script (Diagnostics)\n\nWith your repo folder open in VS Code:\n\n1. Click util_about.py.\n1. If VS Code prompts, install the recommended Python extension.\n1. Check the Python Interpreter: On the bottom-left status bar, you might see a version of Python indicated (e.g., Python 3.12.x).\n1. If not, click on the bottom status bar where it should show the Python version or might say \"Select Python Interpreter\".\n1. From the dropdown, choose your default Python version.\n\nUse the terminal and the python command to execute the Python script. \n\n1. Use your VS Code terminal window from above or open a new terminal window (View / Terminal) in VS Code.\n\nImportant: \n\n- If Mac/Linux, change `python` to `python3` in the commands below.\n- In Windows, you might try `py` instead of `python`.\n\n```shell\npython util_about.py\n```\n\n✔️ Make sure your script runs successfully. \nIf not, post your screenshots and the text of the error message in the discussion.\nThis script must run successfully before continuing. \n---\n\n\n## Explore \u0026 Execute Project Scripts\n\nWith our project repository folder open in VS Code, and having confirmed that we can execute a Python script successfully, it's time to explore. \n\nOpen, read, and run each project script (each file will have a .py extension) in order.\n\nYou don't need to fully understand the code yet. \nInstead, read the code and try to figure out what each file is doing.\n\nWhen you finish, you'll have an idea of some things possible using just the Python standard library. \nYou'll have generated several new data files.\nThe streaming process will run continuously for quite a while. \nRead the comments in the file to learn how to stop the process.\n\nImportant: \n\n- If Mac/Linux, change `python` to `python3` in the commands below.\n- In Windows, you might try `py` instead of `python`.\n- Wait for each script to finish. Did you generate a new datafile? What is the name?\n\n```shell\npython process_batch_A.py\n```\n\n```shell\npython process_batch_B.py\n```\n\n```shell\npython process_batch_C.py\n```\n\n```shell\npython process_streaming_0.py\n```\n\n✔️ Make sure your scripts complete successfully. \nIf not, post screenshots and the text of any error messages in the discussion.\n---\n\n## Update Edit README\n\nEdit this README.md file. It uses Markdown, a simple and easy markup language.\n\n- Keep the prerequisites and task headings. \n- Within the task headings, record only the commands that worked on YOUR machine. \n- Remove unnecessary instructions once you've mastered them.\n- Add any additional notes that will help you in the future.\n\n## Sync to GitHub\n\nNow it's time to get the local work you did on your machine, \nback up to your cloud repo in GitHub.\n\n\n### Option A: Use VS Code (Easy!)\n\n1. On the VS Code side panel, click the source control icon (look for a blue bubble with an number in it).\n1. Important! Above the Commit button, it will say \"Message\". \n1. You MUST include a commit message. \n1. In the commit message input box, type \"initial results\".\n1. Click the down arrow on the blue \"Commit\" button to \"Commit and Push\" to your GitHub repo. \n\nVerify: Open a browser to your GitHub repo and verify the files have appeared. \nIn addition to the original files, you should have one or more new files and an edited Markdown file. \nIf not, return to VS Code and edit/execute files as needed. \nThen commit and push again.\n\nCommon Issue: If your computer hangs because you forgot the commit message, \njust enter your message in the top line of the file it shows in the editor.\nThen click the checkmark in the upper right to close that file and save your commit message.\n\"Sync your changes\" to push to GitHub. \n\n### Option B: Use Git Bash or Terminal Commands (Easy as well):\n\nOpen a new `Git Bash` or Terminal window. Run the following commands one at a time.\nThey will first add all the files (add \"dot\"). \nThen they will commit the changes with a message. \nFinally, they will push the changes up to GitHub.\n\n```\ngit add .\ngit commit -m \"initial results\"\ngit push origin main\n```\n\nOpen a browser and view your GitHub repository. \nVerify your new files have been successfully pushed to GitHub. \n\n✔️ Make sure your git add / commit / push completes successfully. \nIf not, post screenshots, error messages, and questions in the discussion.\nWe've all been there when first learning Git and we can help. \n---\n\n## General Recommendations and Troubleshooting\n\nThe following are general recommendations and troubleshooting tips.\n\n### Issue: VS Code - No Source Control Icon\n\nSuggestion: If you're in VS Code, and you don't see the Source Control icon with a blue bubble, right-click on the sidebar icons, and make sure \"Source Control\" is checked.  \n\n### Issue: VS Code wants to install an extension\n\nIf VS Code suggests an extension, it's often good to go ahead and try it. \nDo a search on the extension to learn more. VS Code suggestions are usually helpful. \n\n## Additional Resources\n\n1. For more information about Git in VS Code, see [Using Git source control in VS Code](https://code.visualstudio.com/docs/sourcecontrol/overview).\n1. For more information about editing Markdown in VS Code, see [Markdown and Visual Studio Code](https://code.visualstudio.com/docs/languages/markdown).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenisecase%2Fstreaming-01-getting-started","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdenisecase%2Fstreaming-01-getting-started","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenisecase%2Fstreaming-01-getting-started/lists"}