Welcome to the Python Skeleton repository! This repository provides a set of pre-configured project skeletons to kickstart your Python development journey.
Each project skeleton is contained within its own isolated folder, complete with its own README file to guide you through the setup and usage. Feel free to explore the different project types and choose the one that best suits your needs.
- Clone this repository to your local machine:
git clone https://github.com/step4ward/python-skeleton.git
cd python-skeleton- Navigate to the specific project folder of your choice:
cd python-skeleton/pure-python # Replace with the desired project folder- Follow the instructions provided in the README of the selected project folder to set up and run the project.
Choose a specific folder that interests you and navigate into it. Each folder contains a starting point for specific types of Python projects. Its own README detailing the instructions.
We use pre-commit to ensure code quality and style consistency. This tool will automatically run checks on your code before each commit. You can find the config in .pre-commit-config.yaml
To set up pre-commit:
- Install
pre-commitfollowing the instruction from pre-commit official documentation -> https://pre-commit.com/#install - Install the pre-commit hooks:
pre-commit installAfter setting up pre-commit, your changes will be automatically checked before each commit. If any issues are found, you'll need to fix them before proceeding with the commit.
We welcome contributions to this repository! If you'd like to add support for additional project types, improve existing skeletons, or fix any issues, feel free to open a pull request. Please refer to our Contribution Guidelines for more information.
This repository is licensed under the MIT License. Feel free to use, modify, and distribute the code as you see fit.
Happy coding and learning! Remember, each step forward is a step closer to mastery. If you have any questions or need assistance, feel free to open an issue or reach out to us.
Created by the Step4ward Team