https://github.com/you-n-g/python-package-github-example

This is an empty Python project example for github to serve as a boilerplate. It aims to free users from repetitive engineering work and make users focus on features.
https://github.com/you-n-g/python-package-github-example

Last synced: 1 day ago
JSON representation

This is an empty Python project example for github to serve as a boilerplate. It aims to free users from repetitive engineering work and make users focus on features.

• Host: GitHub
• URL: https://github.com/you-n-g/python-package-github-example
• Owner: you-n-g
• Created: 2022-10-09T10:54:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-29T07:33:56.000Z (about 2 years ago)
• Last Synced: 2024-11-25T10:47:53.431Z (2 months ago)
• Language: Python
• Homepage:
• Size: 2.93 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Introduction

This is an empty Python project example for github to serve as a boilerplate.

It aims to free users from repetitive engineering work and make users focus on features.

Following features are considered

- Python Package boilerplate.

  - [setup.py](setup.py) 

- Github Actions CI

  - [linting](.github/workflows/linting.yml)

- pre-commit checking.

  - [black,flake8,pyright](.pre-commit-config.yaml) 

- [Git Ignore](.gitignore)

# Development Guidance

## pre-commit checking.

This example has integrated pre-commit, which will make it easier for developers to format and check their code.

Just run the following two commands, and the code will be automatically formatted using black and flake8 when the git commit command is executed.

```bash

pip install -e .[dev]

pre-commit install

```

## Installation

As a developer, you often want make changes to this package and hope it would reflect directly in your environment without reinstalling it. You can install it in editable mode with following command.

The `[dev]` option will help you to install some related packages when developing this package (e.g. flake8, black)

```bash

pip install -e .[dev]

```