https://github.com/perchunpak/python-template

My own template for any Python project.
https://github.com/perchunpak/python-template

Last synced: 18 days ago
JSON representation

My own template for any Python project.

• Host: GitHub
• URL: https://github.com/perchunpak/python-template
• Owner: PerchunPak
• License: mit
• Created: 2022-11-17T15:58:59.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-12-26T00:49:13.000Z (over 1 year ago)
• Last Synced: 2025-02-22T12:14:40.603Z (over 1 year ago)
• Language: Python
• Size: 1.62 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# python-template

[![Support Ukraine](https://badgen.net/badge/support/UKRAINE/?color=0057B8&labelColor=FFD700)](https://savelife.in.ua/en/)

[![Build Status](https://github.com/PerchunPak/python-template/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/PerchunPak/python-template/actions?query=workflow%3Atest)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Python 3.12 badge](https://img.shields.io/badge/python-3.12-blue)](https://www.python.org/downloads/)

My own template for any Python project.

Template can be used anywhere, this includes non-my projects.

## Installing

```bash

pip install cruft lice setuptools

cruft create https://github.com/PerchunPak/python-template

```

### If this doesn't work, try this:

```bash

git clone https://github.com/PerchunPak/python-template.git

cd python-template

```

### Installing `poetry`

Next we need install `poetry` with [recommended way](https://python-poetry.org/docs/master/#installation).

If you use Linux, use command:

```bash

curl -sSL https://install.python-poetry.org | python -

```

If you use Windows, open PowerShell with admin privileges and use:

```powershell

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -

```

### Installing dependencies

```bash

poetry install --no-dev

```

### Run template

```bash

cruft create .

```

### If something is not clear

You can always write me!

## Updating

```bash

cruft update

```

## Projects using it

[List of open-source projects on GitHub with our mention.](https://github.com/search?q=python-template&type=Code)