python-project-template

This is a template for a Python project. It can be used via GitHub's template feature or by copying and pasting the files into your project.

Features

• Poetry for dependency management.
• Ruff for linting and formatting.
• Containerized CI/CD tasks.
• Secure .gitignore and .dockerignore files.
• Example code and tests.

Usage

1. Create a new GitHub repository using this template.

2. Replace the dummy project name python-project-template with your project name.

    find . -type d -name .git -prune  -o -type f -exec sed -i "s/python-project-template/your-project-name/g" {} \;
    git mv python_project_template $PROJECT_PACKAGE
    find . -type d -name .git -prune  -o -type f -exec sed -i "s/python_project_template/$PROJECT_PACKAGE/g" {} \;

3. Replace the dummy python package name python_project_template (snake_case!) with your package name.

    export PROJECT_PACKAGE=your_project_name # snake_case
    git mv python_project_template $PROJECT_PACKAGE
    find . -type d -name .git -prune  -o -type f -exec sed -i "s/python_project_template/$PROJECT_PACKAGE/g" {} \;