Tyler
138 lines
4.9 KiB
Markdown
138 lines
4.9 KiB
Markdown
# Welcome to Learn-Python! 🐍
|
|
|
|
[](https://github.com/TySP-Dev/Learn-Python/stargazers)
|
|
[](https://github.com/TySP-Dev/Learn-Python/network/members)
|
|
[](https://www.gnu.org/licenses/gpl-3.0)
|
|
|
|
> [!NOTE]
|
|
> I'm one person trying to provide a free learning resource.
|
|
> Updates may feel slow, and wiki documents are AI-assisted.
|
|
> However, all content is human-reviewed for accuracy and quality.
|
|
> Solution code is my own work unless stated otherwise - feedback is always welcome!
|
|
|
|
A hands-on Python learning resource featuring practice problems, detailed concept breakdowns, and a supportive community for learners at all levels.
|
|
|
|
## 📚 What's Inside
|
|
|
|
- **Practice Problems**: Jupyter Notebook exercises ranging from beginner to advanced
|
|
- **Detailed Solutions**: Every problem includes thoroughly commented solutions
|
|
- **Concept Wiki**: In-depth explanations of Python fundamentals and best practices
|
|
- **Code Reviews**: Get feedback on your code from the community
|
|
- **Tools Guide**: Recommendations for Python development tools and setup
|
|
|
|
## 📖 Wiki
|
|
|
|
Visit our [Wiki](https://github.com/TySP-Dev/Learn-Python/wiki) to get started!
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### 1. Set Up Your Environment
|
|
Follow our [Development Environment Setup Guide](https://github.com/TySP-Dev/Learn-Python/wiki/Set-up-your-development-environment) to install:
|
|
- Python 3.x
|
|
- Git
|
|
- Jupyter Notebook/Lab
|
|
- A code editor (VS Code recommended)
|
|
|
|
### 2. Clone the Repository
|
|
```bash
|
|
git clone https://github.com/TySP-Dev/Learn-Python.git
|
|
cd Learn-Python
|
|
```
|
|
|
|
### 3. Start Learning!
|
|
```bash
|
|
# Install Jupyter if you haven't already
|
|
pip install jupyterlab
|
|
|
|
# Launch Jupyter
|
|
jupyter lab
|
|
|
|
# Open any notebook in the problems folder and start coding!
|
|
```
|
|
|
|
## 📂 Repository Structure
|
|
|
|
```
|
|
Learn-Python/
|
|
├── problems/
|
|
│ ├── beginner/ # Beginner-friendly exercises
|
|
│ ├── intermediate/ # Intermediate challenges
|
|
│ └── advanced/ # Advanced problems
|
|
├── solutions/
|
|
│ ├── beginner/ # Solutions with detailed explanations
|
|
│ ├── intermediate/
|
|
│ └── advanced/
|
|
├── resources/ # Additional learning materials
|
|
└── README.md
|
|
```
|
|
|
|
## 💬 Getting Help
|
|
|
|
- **Questions about Python?** Open a [discussion](https://github.com/TySP-Dev/Learn-Python/discussions)
|
|
- **Found a bug?** Submit an [issue](https://github.com/TySP-Dev/Learn-Python/issues)
|
|
- **Want code review?** Check out our [Code Review Guide](https://github.com/TySP-Dev/Learn-Python/wiki/Code-Review!)
|
|
|
|
## 🤝 Contributing
|
|
|
|
Contributions are welcome! Here's how you can help:
|
|
|
|
### 📝 Reporting Issues
|
|
- **Errors or typos**: Open an issue describing what needs fixing or submit a PR!
|
|
- **Unclear explanations**: Let me know which concept needs better clarification
|
|
- **Broken code**: Report any solutions that don't work as expected
|
|
|
|
### 💡 Suggesting Content
|
|
- **New topics**: Propose Python concepts you'd like covered
|
|
- **Practice problems**: Suggest exercises that helped you learn
|
|
- **Tools/resources**: Recommend useful Python tools or libraries
|
|
|
|
### ✏️ Submitting Changes
|
|
|
|
**Pull Requests Welcome!**
|
|
PRs are encouraged, but all submissions must be reviewed and approved by myself or featured contributors before merging.
|
|
|
|
**Wiki Edits**
|
|
- Fix typos, improve wording, or clarify explanations
|
|
- Ensure changes maintain consistency with existing style
|
|
- Keep explanations beginner-friendly
|
|
|
|
**Code Solutions**
|
|
- Follow [PEP 8](https://peps.python.org/pep-0008/) style guidelines
|
|
- Include comments explaining your approach
|
|
- Test thoroughly before submitting
|
|
- Add docstrings for functions
|
|
|
|
**New Problems**
|
|
- Provide a clear problem description
|
|
- Include at least one solution with explanation
|
|
- Indicate difficulty level (Beginner/Intermediate/Advanced)
|
|
|
|
### ⚠️ What Not to Submit
|
|
- AI-generated solutions without personal understanding
|
|
- Overly complex solutions when simpler ones exist
|
|
- Content copied from other sources without attribution
|
|
|
|
### Review Process
|
|
As a solo maintainer, reviews may take a few days. I'll provide feedback and work with you to refine contributions before merging. All PRs require approval from myself or featured contributors before they can be merged.
|
|
|
|
## 📝 License
|
|
|
|
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
|
|
|
|
## ⭐ Support
|
|
|
|
If you find this resource helpful, please consider:
|
|
- ⭐ Starring the repository
|
|
- 🔄 Sharing it with others
|
|
- 🤝 Contributing your own problems and solutions
|
|
|
|
## 🙏 Acknowledgments
|
|
|
|
Thank you to all contributors and learners who help make this resource better!
|
|
|
|
---
|
|
|
|
**Questions?** [Open an issue](https://github.com/TySP-Dev/Learn-Python/issues) and I'll be happy to discuss!
|
|
|
|
**Happy Coding!** 🐍✨
|