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

Add project template improvements #99

Merged
merged 27 commits into from
May 10, 2022
Merged

Conversation

rszamszur
Copy link
Member

@rszamszur rszamszur commented May 8, 2022

Checklist:

  • Added tests for changed code where applicable.
  • Documentation reflects the changes where applicable.
  • Updated the CHANGELOG.md file with your changes.
  • My PR is ready to review.

Resolves: #90
Resolves: #89

Description of the changes being introduced by the pull request:
Still TODO:

  • Fix project template style guide
  • Refactor some of the project template configuration
    * remove --skip-vagrantfile
    * remove --skip-redis (?)
    * remove --skip-helm (?)
  • Update docs, readme
  • Add --skip-docs option (?)
  • Add GH pages docs deployment if GH actions enabled
  • Move generated HOW TO in project readme to generated Sphinx docs

@rszamszur rszamszur added enhancement New feature or request refactor Related to major code refactoring/reorganisation labels May 8, 2022
@rszamszur rszamszur added this to the 0.12.0 milestone May 8, 2022
@rszamszur rszamszur self-assigned this May 8, 2022
@rszamszur rszamszur added the copier: project Related to copier template label May 8, 2022
@rszamszur
Copy link
Member Author

rszamszur commented May 9, 2022

This PR will also refactor generated project CLI serve command to use --bind instead of --host and --port for compatibility sake with gunicorn. Implementing #25 should be easier now. However, env variables FASTAPI_HOST FASTAPI_PORT will need to be refactored to FASTAPI_BIND as well.

EDIT:
Also currently there is no validation for the --bind option. However, this will be done by gunicorn anyways. I wonder if it's really that needed to validate it in click.Option callback.

@rszamszur rszamszur marked this pull request as ready for review May 10, 2022 18:26
@github-actions
Copy link
Contributor

github-actions bot commented May 10, 2022

@codecov-commenter
Copy link

codecov-commenter commented May 10, 2022

Codecov Report

Merging #99 (e82ba2b) into master (54fc259) will increase coverage by 0.37%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           master       #99      +/-   ##
===========================================
+ Coverage   99.62%   100.00%   +0.37%     
===========================================
  Files          39        40       +1     
  Lines         797       800       +3     
===========================================
+ Hits          794       800       +6     
+ Misses          3         0       -3     
Impacted Files Coverage Δ
fastapi_mvc/commands/base.py 100.00% <ø> (ø)
fastapi_mvc/commands/invoker.py 100.00% <ø> (ø)
fastapi_mvc/generators/controller/__init__.py 100.00% <ø> (ø)
fastapi_mvc/generators/generator/__init__.py 100.00% <ø> (ø)
...cookiecutter.package_name}}/app/exceptions/http.py 100.00% <ø> (ø)
...ecutter.package_name}}/app/utils/aiohttp_client.py 100.00% <ø> (ø)
...}/{{cookiecutter.package_name}}/app/utils/redis.py 100.00% <ø> (ø)
...}/{{cookiecutter.package_name}}/app/views/error.py 100.00% <ø> (ø)
...}/{{cookiecutter.package_name}}/app/views/ready.py 100.00% <ø> (ø)
...{cookiecutter.package_name}}/config/application.py 100.00% <ø> (ø)
... and 31 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a6da4dd...e82ba2b. Read the comment docs.

@rszamszur rszamszur merged commit 8b6394f into master May 10, 2022
@rszamszur rszamszur deleted the project_template_improvements branch May 10, 2022 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
copier: project Related to copier template enhancement New feature or request refactor Related to major code refactoring/reorganisation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor/improve project template structure Add Sphinx autodoc documentation for project template
2 participants