Add init template for flask-framework #1428
Conversation
|
I have chosen to omit certain files, such as tests and |
| @@ -0,0 +1 @@ | |||
| https://github.com/canonical/xiilib/archive/v0.1.0.tar.gz | |||
There was a problem hiding this comment.
Out of interest, what's the name? xiilib? Feels a bit cryptic?
There was a problem hiding this comment.
Yes, it was originally going to be 12f, but names starting with a number caused some problems, so I substituted it with number XII.
There was a problem hiding this comment.
Any great ideas for better names are more than welcome 🙂
There was a problem hiding this comment.
how about twelve-f? Looks awkward at first glance but reads the same as 12f
There was a problem hiding this comment.
I'll throw my hat in the ring with zwolf. Advantages:
- Is the German word for twelve
- Isn't yet registered on pypi
- Includes the substring "wolf" 🐺
There was a problem hiding this comment.
How about ffffffffffff, and it's pronounced as /ɛfɛfɛfɛfɛfɛfɛfɛfɛfɛfɛfɛf/ 🤣
| @@ -0,0 +1,30 @@ | |||
| #!/usr/bin/env python3 | |||
| # Copyright 2023 Canonical Ltd. | |||
There was a problem hiding this comment.
The author/year needs to be templated
| # Uncomment the integrations used by your application | ||
| # requires: | ||
| # mysql: | ||
| # interface: mysql_client | ||
| # limit: 1 | ||
| # postgresql: | ||
| # interface: postgresql_client | ||
| # limit: 1 |
There was a problem hiding this comment.
Should this include all of the integrations we support? E.g., ingress seems to be missing?
There was a problem hiding this comment.
Ingress and other relations are default and static for now, so user can't change them.
| super().__init__(*args) | ||
|
|
||
|
|
||
| if __name__ == "__main__": # pragma: nocover |
There was a problem hiding this comment.
Should we remove the pragma: nocover? It might not be relevant for all users
| @@ -0,0 +1 @@ | |||
| https://github.com/canonical/xiilib/archive/v0.1.0.tar.gz | |||
There was a problem hiding this comment.
Any great ideas for better names are more than welcome 🙂
| @@ -35,6 +35,7 @@ | |||
| "simple": "init-simple", | |||
| "kubernetes": "init-kubernetes", | |||
| "machine": "init-machine", | |||
| "flask-framework": "init-flask-framework", | |||
There was a problem hiding this comment.
Please update _overview below to include a description of this template.
There was a problem hiding this comment.
I have added an one sentence summary for now, but I will add a link to the document once we have published the document for the 12-factor project.
| mkdir -p test-init | ||
| cd test-init | ||
| charmcraft init --profile flask-framework | ||
| export CHARMCRAFT_ENABLE_EXPERIMENTAL_EXTENSIONS=true |
There was a problem hiding this comment.
This can be set in an environment keyword for the task. Here's an example
There was a problem hiding this comment.
Updated, thanks!
| @@ -0,0 +1,31 @@ | |||
| # This file configures Charmcraft. | |||
| # See https://juju.is/docs/sdk/charmcraft-config for guidance. | |||
|
|
|||
There was a problem hiding this comment.
While the extension does fill in the type field, I'd prefer if we keep it in the template too, since a user might see from the documentation that it's required and be confused by it. This confusion will become more obvious when we make a jsonschema for charmcraft.yaml, since that will mark type as required (and thus IDEs will start complaining about its nonexistence).
There was a problem hiding this comment.
Gotcha, added, thanks!
| @@ -0,0 +1 @@ | |||
| https://github.com/canonical/xiilib/archive/v0.1.0.tar.gz | |||
There was a problem hiding this comment.
how about twelve-f? Looks awkward at first glance but reads the same as 12f
Introduce a new profile called
flask-frameworkto the charmcraft init command to create basic projects for 12-factor Flask charms