See also: How to set up a charm project
Below is a list of the files you may encounter in a charm project. This includes:
- files created automatically for you when you set up a charm project with
charmcraft init
(e.g., all the 3 crucial files –charmcraft.yaml
,requirements.txt
, andsrc/charm.py
– but not just; you’ll likely want to edit all) - files created automatically for you when you pack a charm with
charmcraft pack
(e.g.,actions.yaml
,config.yaml
,dispatch
,manifest.yaml
,metadata.yaml
) - files you may want to add on your own (e.g.,
icon.svg
,lxd-profile.yaml
).
Click on a title to find out more.
Filename | Created by charmcraft init
|
Created by charmcraft pack
|
---|---|---|
CONTRIBUTING.md |
||
LICENSE |
||
README.md |
||
actions.yaml |
||
charmcraft.yaml |
||
config.yaml |
||
dispatch |
||
icon.svg |
||
lxd-profile.yaml |
||
manifest.yaml |
||
metadata.yaml |
||
pyproject.toml |
||
requirements-dev.txt |
||
requirements.txt |
||
src/charm.py |
||
tests/unit/test_charm.py |
||
tests/integration/test_charm.py |
||
tox.ini |