Bradley/2022PythonExamples
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial README setup experimentation

Browse Source
This commit is contained in:
Bradley Bickford 2022-12-10 11:31:46 -05:00
parent 45c6f807b6
commit 617abfea1a
2 changed files with 13 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
1 - Getting Started/README.md Normal file
View File

@ -0,0 +1 @@
# TEST

97
README.md
View File

@ -1,92 +1,19 @@
# 2022TrainingPythonRedux
# 2022 Training Python Redux
Given the interest in using Python by a Maine Rookie Team for the 2023 season, I've decided the best course of action is to try and re-work my original examples from the 2022 Java Training into Python.
## Is this training a replacement for learning the fundamentals of Python?
No. While I do include some basics in the first few folders, the fundamentals of Python and of programming in general can't be conveyed so quickly. If you're interested in more training in the fundamentals of Python beyond a quick overview, I recommend the training provided by [OpenEDG](https://openedg.org/). They provide free, self paced Python training for beginners up through advanced Python users. These trainings are oriented towards passing industry standard certifications, so for older students who are interested in going into Computer Science, these trainings are a good opportunity to get a head start towards achieving entry to mid-level Python certifications that are industry recognized. More information can be found at [The Python Institute](https://pythoninstitute.org/).
## Getting started
## How to go through these folders?
Start with the lowest numbered folder, and keep working your way up. I <b>DO NOT</b> recommend you jump around if you are new to Python/Robot Programming. Many of the examples and challenges build on previous concepts shown in other examples.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
In each folder there is a README.md, if you're viewing this code on GitLab, the content on the README is shown underneath the file view, similar to where this document is placed. You should read the README prior to looking at the code.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## How will I know what the code is doing?
I will provide comments similar to the ones I provided for the Java oriented programming training. In many cases, the comments will be comprehensive enough to get you an understanding of what is going on. If you get stuck, or you have extra questions that Google isn't helping you answer, I'm happy to answer questions. Send me an email at [bradleybickford@gmail.com](mailto:bradleybickford@gmail.com), make sure your subject line contains FRC PYTHON HELP in big capital letters, I get a lot of junk mail, and I wouldn't want to miss your email...
## Add your files
## What are these challenges?
The challenge solutions are "homework assignments" that I had originally given during the programming training course held in the Summer of 2022. I gave a prompt, and the students that wanted to could go and try the challenge over the course of a week. When the next training session came around, we'd talk about any questions, and I'd release a full solution (a challenge solution) that contained comments to explain why and how certain things were done.
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://gitlab.coldlightalchemist.com/brad95411/2022trainingpythonredux.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://gitlab.coldlightalchemist.com/brad95411/2022trainingpythonredux/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
While I agree that sometimes homework can be awful, trying things for yourself can be great to increase your understanding, especially when programming. I strongly encourage you to try to do some of the challenges yourself, experiment, ask Google, and try to break stuff. The prompts that I originally gave will be in the readme of each challenge solution folder. Read the prompt, give it a try for yourself, and then review the actual solution to see how close you got.