initial commit

This commit is contained in:
2024-11-09 08:01:27 -08:00
parent 87d31059ad
commit 0e9b465413
42 changed files with 1403 additions and 37 deletions

1
project_name/VERSION Normal file
View File

@@ -0,0 +1 @@
0.1.0

0
project_name/__init__.py Normal file
View File

6
project_name/__main__.py Normal file
View File

@@ -0,0 +1,6 @@
"""Entry point for project_name."""
from project_name.cli import main # pragma: no cover
if __name__ == "__main__": # pragma: no cover
main()

17
project_name/base.py Normal file
View File

@@ -0,0 +1,17 @@
"""
project_name base module.
This is the principal module of the project_name project.
here you put your main classes and objects.
Be creative! do whatever you want!
If you want to replace this with a Flask application run:
$ make init
and then choose `flask` as template.
"""
# example constant variable
NAME = "project_name"

28
project_name/cli.py Normal file
View File

@@ -0,0 +1,28 @@
"""CLI interface for project_name project.
Be creative! do whatever you want!
- Install click or typer and create a CLI app
- Use builtin argparse
- Start a web application
- Import things from your .base module
"""
def main(): # pragma: no cover
"""
The main function executes on commands:
`python -m project_name` and `$ project_name `.
This is your program's entry point.
You can change this function to do whatever you want.
Examples:
* Run a test suite
* Run a server
* Do some other stuff
* Run a command line application (Click, Typer, ArgParse)
* List all available tasks
* Run an application (Flask, FastAPI, Django, etc.)
"""
print("This will do something")