A boilerplate for creating Python packages quickly and efficiently. This template provides a clean and standardized structure to start building your Python project.
- Pre-configured setup for packaging and distribution.
- Includes CI/CD workflows with GitHub Actions.
- Standard Python files:
setup.py,pyproject.toml,LICENSE, and more. - Modular structure to organize your source code and notebooks.
- Easy initialization with the
create_project.shscript.
- Python 3.7 or higher.
- Git installed on your system.
-
Create a new repository in your Github named
project_name. -
Create a bash script named
create_project.shView create_project.sh. -
Run the
create_project.shscript to initialize your project:
./create_project.sh <project_name> <author_name> <author_email> <github_username>- Your new project will be created in the
<project_name>directory, initialized with a new Git repository, and pushed tohttps://github.com/<github_username>/<project_name>.git.
src/: Main source code folder for your package.notebooks/: Directory for Jupyter notebooks.setup.pyandpyproject.toml: Files for packaging and dependencies..github/workflows/: Ready-to-use CI/CD workflows.- README.md: A template for your project documentation.
-
Navigate to your project directory:
cd <project_name>
-
Create a virtual environment and install dependencies:
python -m venv venv source venv/bin/activate # On Windows: venv\\Scripts\\activate pip install -r requirements.txt
-
Start coding!
The script automatically sets up a remote repository based on your GitHub username and project name. After running the script, your repository will be pushed to: https://github.com/<github_username>/<project_name>.git
No additional manual steps are needed to link the remote repository.
Contributions are welcome! Please fork the repository, make your changes, and submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.