Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: make package/app choice explicit #222

Merged
merged 10 commits into from
Apr 5, 2024
Merged

feat!: make package/app choice explicit #222

merged 10 commits into from
Apr 5, 2024

Conversation

lsorber
Copy link
Member

@lsorber lsorber commented Apr 3, 2024

Significant rework of the template options with breaking changes because template parameters are renamed and options are removed.

Changes:

  • Introduce an explicit "project_type": ["package", "app"] choice as the very first choice to make.
  • Rename package_(name|description|url) to project_(name|description|url).
  • For applications, the latest Python version is selected by default, and for packages 3.10 is selected by default.
  • Make docker_image a hidden parameter __docker_image.
  • Remove spurious with_jupyter_lab.
  • Remove with_pydantic_typing – enabled when selecting with_fastapi_api.
  • Remove with_sentry_logging – handholding is of limited value for this feature.
  • Remove with_streamlit_app – this is perhaps a little too opinionated as users may want to use Gradio instead.
  • Make docstring_style a hidden parameter __docstring_style.
  • Update FastAPI template with latest lifecycle best practices.
  • Update FastAPI to provide an async endpoint instead a synchronous one, including a CPU-bound method (as that is a footgun with async FastAPI).
  • Update Typer template with a more realistic example of how to print output with rich (typer.echo is discouraged now).
  • Expanded test matrix to test both package and app scaffoldings.
  • Minimum Python version is now 3.9 (needed for asyncio.to_thread and pre-commit).
  • Increased support to Python 3.12.

Closes #219.

@lsorber lsorber requested a review from JWuzyk April 3, 2024 13:27
@lsorber lsorber self-assigned this Apr 3, 2024
@lsorber lsorber changed the title feat!: make package/application choice explicit feat!: make package/app choice explicit Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove unnecessary options
2 participants