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

Integrate the API repository template #90

Open
greschd opened this issue May 20, 2022 · 0 comments · May be fixed by #281
Open

Integrate the API repository template #90

greschd opened this issue May 20, 2022 · 0 comments · May be fixed by #281
Labels
enhancement New features or code improvements
Milestone

Comments

@greschd
Copy link
Member

greschd commented May 20, 2022

Description of the feature

The API repository template is an existing cookiecutter template aimed specifically at creating gRPC API repositories. It uses the protoc compilation helper to automatically compile the .proto files to Python files when building the Python wheel. To enable this, setuptools is used for packaging.

It would be useful to include the API template as part of this repository and deprecate the current repo, to aid discoverability and make it clear which is the most up-to-date version.

Steps for implementing the feature

Mostly, I think the current cookiecutter template can be copied into ansys-templates without much modification.

One open question is testing: Currently, the ansys-api-template repository includes tests which check that the protobuf compilation works on the resulting repository.

Since adding tests specific to a given template seems more broadly useful, maybe we should think how to solve this in general (adding some hook mechanism or common layout for tests?).

As this testing setup will take some work, we can consider merging the API template without its accompanying tests at first, and solving the testing requirement in a separate PR.

Useful links and references

No response

@greschd greschd added the enhancement New features or code improvements label May 20, 2022
@jorgepiloto jorgepiloto added this to the 0.4 milestone Jun 20, 2022
@jorgepiloto jorgepiloto linked a pull request Jun 21, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants