An open API service indexing awesome lists of open source software.

https://github.com/ysskrishna/tkinter-poetry-starter

A Copier template for building cross-platform desktop applications using Python's Tkinter and Poetry. This template serves as the foundation for production-ready GUI applications.
https://github.com/ysskrishna/tkinter-poetry-starter

boilerplate copier copier-template cross-platform desktop-application github-actions gui open-source poetry python python-gui release-automation scaffolding starter-template tkinter tkinter-gui ysskrishna

Last synced: about 1 month ago
JSON representation

A Copier template for building cross-platform desktop applications using Python's Tkinter and Poetry. This template serves as the foundation for production-ready GUI applications.

Awesome Lists containing this project

README

          

# Tkinter Poetry Starter Template

[![Python](https://img.shields.io/badge/Python-3.9+-blue.svg)](https://www.python.org/downloads/)
[![Poetry](https://img.shields.io/badge/Poetry-1.4.0+-blue.svg)](https://python-poetry.org/)
[![Copier](https://img.shields.io/badge/Copier-8.0.0+-blue.svg)](https://copier.readthedocs.io/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A [Copier](https://copier.readthedocs.io/) template for building cross-platform desktop applications using Python's Tkinter and Poetry. This template serves as the foundation for production-ready GUI applications, as demonstrated by projects like [Directory Printer](https://github.com/ysskrishna/directory-printer) which was built using this starter.

Tkinter Poetry Starter Template - Kickstart your python GUI projects with Tkinter & Poetry! | Product Hunt

## Features
- **Modern Project Generation**
- Built with Copier for flexible template-based project creation
- Interactive project setup with customizable options
- Consistent project structure across all new applications
- **Cross-Platform Compatibility** - Runs on Windows, Linux, and macOS
- **Automated Builds** - GitHub Actions workflow for automatic binary creation on release
- **Developer Friendly**
- Pre-commit hooks for code quality
- Comprehensive documentation
- Easy-to-use commands for running and building
- **Professional Project Structure**
- Uses Poetry for dependency management
- Organized module structure with separate core and GUI components
- Pre-configured development tools (Black, isort, pylint)
- **Project Assets & Documentation**
- Custom application logo included
- Detailed changelog for version tracking

## Requirements

- Python 3.9 or higher
- [Copier](https://copier.readthedocs.io/) 8.0.0 or higher
- [Poetry](https://python-poetry.org/) 1.4.0 or higher

## Quick Start

1. Install Copier if you haven't already:
```bash
pip install copier
```

2. Create a new project:
```bash
copier copy gh:ysskrishna/tkinter-poetry-starter
```

## Template Options

The template will ask for the following information:

- `project_name`: Name of your project
- `project_description`: Brief description of your project
- `author_name`: Your full name
- `author_email`: Your email address

## License

This template is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.