# Craft Grammar
This project aims to provide python interfaces for using advanced
grammar in [Craft Parts](https://craft-grammar.readthedocs.io)
# License
Free software: GNU Lesser General Public License v3
# Documentation:
https://craft-grammar.readthedocs.io.
# Contributing
A `Makefile` is provided for easy interaction with the project. To see
all available options run:
make help
## Running tests
To run all tests in the suite run:
make tests
## Adding new requirements
If a new dependency is added to the project run:
make freeze-requirements
## Verifying documentation changes
To locally verify documentation changes run:
make docs
After running, newly generated documentation shall be available at
`./docs/_build/html/`.
## Committing code
Please follow these guidelines when committing code for this project:
- Use a topic with a colon to start the subject
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Do not capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why (instead of how)
As an example:
endpoints: support package attenuations
Required in order to obtain credentials that apply only to a given package;
be it charm, snap or bundle.
Raw data
{
"_id": null,
"home_page": "https://github.com/canonical/craft-grammar",
"name": "craft-grammar",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Canonical Ltd.",
"author_email": "snapcraft@lists.snapcraft.io",
"download_url": "https://files.pythonhosted.org/packages/d7/2c/75f3dc538dae5f60e81fb5fb0c00b4b7bb7f0c29e4b8f76dcb4cc0541b28/craft-grammar-1.1.2.tar.gz",
"platform": null,
"description": "# Craft Grammar\n\nThis project aims to provide python interfaces for using advanced\ngrammar in [Craft Parts](https://craft-grammar.readthedocs.io)\n\n# License\n\nFree software: GNU Lesser General Public License v3\n\n# Documentation:\n\nhttps://craft-grammar.readthedocs.io.\n\n# Contributing\n\nA `Makefile` is provided for easy interaction with the project. To see\nall available options run:\n\n make help\n\n## Running tests\n\nTo run all tests in the suite run:\n\n make tests\n\n## Adding new requirements\n\nIf a new dependency is added to the project run:\n\n make freeze-requirements\n\n## Verifying documentation changes\n\nTo locally verify documentation changes run:\n\n make docs\n\nAfter running, newly generated documentation shall be available at\n`./docs/_build/html/`.\n\n## Committing code\n\nPlease follow these guidelines when committing code for this project:\n\n- Use a topic with a colon to start the subject\n- Separate subject from body with a blank line\n- Limit the subject line to 50 characters\n- Do not capitalize the subject line\n- Do not end the subject line with a period\n- Use the imperative mood in the subject line\n- Wrap the body at 72 characters\n- Use the body to explain what and why (instead of how)\n\nAs an example:\n\n\n endpoints: support package attenuations\n\n Required in order to obtain credentials that apply only to a given package;\n be it charm, snap or bundle.\n",
"bugtrack_url": null,
"license": "GNU Lesser General Public License v3 (LGPLv3)",
"summary": "\"Advance Grammar for Craft Parts\"",
"version": "1.1.2",
"project_urls": {
"Documentation": "https://craft-grammar.readthedocs.io/en/latest/",
"Homepage": "https://github.com/canonical/craft-grammar",
"Issues": "https://github.com/canonical/craft-grammar/issues",
"Source": "https://github.com/canonical/craft-grammar.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c5fc6c97911238257a24067f7638e0baae0bd7968dc0b09a2a98552b42a9629c",
"md5": "ba3267036362eff215806859bdf23737",
"sha256": "feeb9d628ca75fff8a503d88804b21ac9629329c56cb69c45638b1646c540f75"
},
"downloads": -1,
"filename": "craft_grammar-1.1.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba3267036362eff215806859bdf23737",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 19454,
"upload_time": "2023-12-04T15:48:49",
"upload_time_iso_8601": "2023-12-04T15:48:49.929034Z",
"url": "https://files.pythonhosted.org/packages/c5/fc/6c97911238257a24067f7638e0baae0bd7968dc0b09a2a98552b42a9629c/craft_grammar-1.1.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d72c75f3dc538dae5f60e81fb5fb0c00b4b7bb7f0c29e4b8f76dcb4cc0541b28",
"md5": "efd83c20920f1625339f96a75a9e4b75",
"sha256": "3ecbb4417e7152048ebe4f04ef2ea07bdc4a2b6d185ffdea30a9239c307fdf3c"
},
"downloads": -1,
"filename": "craft-grammar-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "efd83c20920f1625339f96a75a9e4b75",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14887,
"upload_time": "2023-12-04T15:48:51",
"upload_time_iso_8601": "2023-12-04T15:48:51.379618Z",
"url": "https://files.pythonhosted.org/packages/d7/2c/75f3dc538dae5f60e81fb5fb0c00b4b7bb7f0c29e4b8f76dcb4cc0541b28/craft-grammar-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-04 15:48:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "canonical",
"github_project": "craft-grammar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "craft-grammar"
}
JSON
