https://github.com/xinntao/projecttemplate-python

Python Project Template
https://github.com/xinntao/projecttemplate-python

python template

Last synced: 5 months ago
JSON representation

Python Project Template

• Host: GitHub
• URL: https://github.com/xinntao/projecttemplate-python
• Owner: xinntao
• License: mit
• Created: 2020-11-19T03:11:07.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-10-22T09:29:40.000Z (almost 4 years ago)
• Last Synced: 2025-03-31T07:34:23.494Z (6 months ago)
• Topics: python, template
• Language: Python
• Homepage: https://xinntao.github.io/
• Size: 19.5 KB
• Stars: 210
• Watchers: 5
• Forks: 51
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ProjectTemplate-Python

[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/xinntao/HandyView.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/xinntao/HandyView/context:python)

[![download](https://img.shields.io/github/downloads/xinntao/Real-ESRGAN/total.svg)](https://github.com/xinntao/Real-ESRGAN/releases)

[![Open issue](https://isitmaintained.com/badge/open/xinntao/basicsr.svg)](https://github.com/xinntao/basicsr/issues)

[![PyPI](https://img.shields.io/pypi/v/basicsr)](https://pypi.org/project/basicsr/)

[![LICENSE](https://img.shields.io/github/license/xinntao/basicsr.svg)](https://github.com/xinntao/BasicSR/blob/master/LICENSE/LICENSE)

[![python lint](https://github.com/xinntao/BasicSR/actions/workflows/pylint.yml/badge.svg)](https://github.com/xinntao/BasicSR/blob/master/.github/workflows/pylint.yml)

[![Publish-pip](https://github.com/xinntao/BasicSR/actions/workflows/publish-pip.yml/badge.svg)](https://github.com/xinntao/BasicSR/blob/master/.github/workflows/publish-pip.yml)

[![gitee mirror](https://github.com/xinntao/BasicSR/actions/workflows/gitee-mirror.yml/badge.svg)](https://github.com/xinntao/BasicSR/blob/master/.github/workflows/gitee-mirror.yml)

[English](README.md) **|** [简体中文](README_CN.md)   [GitHub](https://github.com/xinntao/ProjectTemplate-Python) **|** [Gitee码云](https://gitee.com/xinntao/ProjectTemplate-Python)

## File Modification

1. Setup *pre-commit* hook

    1. If necessary, modify `.pre-commit-config.yaml`

    1. In the repository root path, run

    > pre-commit install

1. Modify the `.gitignore` file

1. Modify the `LICENSE` file

    This repository uses the *MIT* license, you may change it to other licenses

1. Modify the *setup* files

    1. `setup.cfg`

    1. `setup.py`, especially the `basicsr` keyword

1. Modify the `requirements.txt` files

1. Modify the `VERSION` file

## GitHub Workflows

1. [pylint](./github/workflows/pylint.yml)

1. [gitee-repo-mirror](./github/workflow/gitee-repo-mirror.yml) - Support Gitee码云

    1. Clone GitHub repo in the [Gitee](https://gitee.com/) website

    1. Modify [gitee-repo-mirror](./github/workflow/gitee-repo-mirror.yml)

    1. In Github *Settings* -> *Secrets*, add `SSH_PRIVATE_KEY`

## Other Procedures

1. The `description`, `website`, `topics` in the main page

1. Support Chinese documents, for example, `README_CN.md`

## Emoji

[Emoji cheat-sheet](https://github.com/ikatyang/emoji-cheat-sheet)

| Emoji | Meaning |

| :---         |     :---:      |

| :rocket:   | Used for [BasicSR](https://github.com/xinntao/BasicSR) Logo |

| :sparkles: | Features |

| :zap: | HOWTOs |

| :wrench: | Installation / Usage |

| :hourglass_flowing_sand: | TODO list |

| :turtle: | Dataset preparation |

| :computer: | Commands |

| :european_castle: | Model zoo |

| :memo: | Designs |

| :scroll: | License and acknowledgement |

| :earth_asia: | Citations |

| :e-mail: | Contact |

| :m: | Models |

| :arrow_double_down: | Download |

| :file_folder: | Datasets |

| :chart_with_upwards_trend: | Curves|

| :eyes: | Screenshot |

| :books: |References |

## Useful Image Links

  Google Colab Logo 


  Windows Logo 


  Ubuntu Logo 


## Other Useful Tips

1. `More` drop-down menu

    

    More

    


    
Nov 19, 2020. Set up ProjectTemplate-Python.