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

add setup.py, sphinx
https://github.com/gsy0911/template-python

Last synced: 4 months ago
JSON representation

add setup.py, sphinx

• Host: GitHub
• URL: https://github.com/gsy0911/template-python
• Owner: gsy0911
• Created: 2020-07-18T01:40:17.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-08-14T23:07:26.000Z (almost 2 years ago)
• Last Synced: 2025-01-22T07:41:52.066Z (6 months ago)
• Language: Python
• Homepage:
• Size: 175 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# template-python

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

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)

# setup

## modify files

* add {project_name} folder

* modify `pyproject.toml`

  * set `{project_name}` 

  * set `{your_name}` 

  * set `{your_email}`

  * remove un-necessary package

* modify `Makefile`

  * set `{your_module}`

* modify `setup.py` 

  * set `{...}`

* modify `docs/conf.py`

  * set `{project_name}` 

  * set `{author}` 

## install venv with poetry

```shell script

$ poetry install

```