Metadata-Version: 2.2
Name: craft-grammar
Version: 2.0.2
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: overrides
Requires-Dist: pydantic~=2.0
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: coverage[toml]~=7.4; extra == "dev"
Requires-Dist: pytest~=8.0; extra == "dev"
Requires-Dist: pytest-cov~=6.0; extra == "dev"
Requires-Dist: pytest-mock~=3.12; extra == "dev"
Requires-Dist: PyYAML; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Requires-Dist: types-setuptools; extra == "dev"
Requires-Dist: types-PyYAML; extra == "dev"
Provides-Extra: lint
Requires-Dist: black~=24.1; extra == "lint"
Requires-Dist: codespell[toml]~=2.2; extra == "lint"
Requires-Dist: ruff~=0.7.0; extra == "lint"
Requires-Dist: yamllint~=1.34; extra == "lint"
Provides-Extra: types
Requires-Dist: mypy[reports]~=1.13.0; extra == "types"
Requires-Dist: pyright==1.1.389; extra == "types"
Provides-Extra: docs
Requires-Dist: canonical-sphinx~=0.1; extra == "docs"
Requires-Dist: sphinx-autobuild~=2024.2; extra == "docs"
Requires-Dist: sphinx-toolbox~=3.5; extra == "docs"
Requires-Dist: sphinx-lint==1.0.0; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints~=2.1; extra == "docs"

# 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.
