https://github.com/pykong/py-template-repo

Template repository for Python projects.
https://github.com/pykong/py-template-repo

docker poetry pyproject-toml pytest python template-project visual-studio-code

Last synced: 21 days ago
JSON representation

Template repository for Python projects.

• Host: GitHub
• URL: https://github.com/pykong/py-template-repo
• Owner: pykong
• Created: 2023-04-21T17:43:37.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-15T07:36:48.000Z (3 months ago)
• Last Synced: 2024-10-17T04:44:37.145Z (2 months ago)
• Topics: docker, poetry, pyproject-toml, pytest, python, template-project, visual-studio-code
• Language: Python
• Homepage:
• Size: 85 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Readme

## How to run

Execute:

`poetry run src 'Ben'`

You will see a logline and 'Hello, Ben!' printed on the console.

The above command calls a script entry point that internally invokes:

`poetry run python -m src 'Ben'`

To see all possible command targets invoke the `typer` help.

`poetry run src --help`

### Running tests

`poetry run pytest`

See: 

## Links

- [Poetry Docs](https://python-poetry.org/docs/)

- [Python Docs: Modules & Packages](https://docs.python.org/3/tutorial/modules.html#packages)