build: make project PEP 561 compliant

elixir-cloud-aai / foca

Opinionated Flask microservice archetype for quick OpenAPI-based microservice development

Apache License 2.0

16 stars 12 forks source link

build: make project PEP 561 compliant #191

Closed Rahuljagwani closed 11 months ago

Rahuljagwani commented 11 months ago

Description

Fixes #187

STEPS:

Created py.typed file in the root directory.
Mentioned the same in setup.py.

@uniqueg, I closed the previous PR because of a linting error. Can you please review this?

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)

Checklist:

[ ] My code follows the style guidelines of this project
[ ] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have updated the documentation (or documentation does not need to be updated)
[ ] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[ ] I have not reduced the existing code coverage

uniqueg commented 11 months ago

@Rahuljagwani: The CI failed because pull requests from forks do not have access to secrets set up for this repository (this is a security feature by GitHub). I should have thought about this earlier, my apologies.

Two ways to solve this:

I have invited you to our organization. If you clone the repo, create a new feature branch off with git checkout -b pep561, apply your changes, commit, push and then create a PR from the feature branch, the CI should pass and we can merge it. That way you would get full credits for the resulting commit.
Alternatively, I would quickly do it myself and add you as a co-author.

Please let me know how you would like to proceed (or, if you go with option 1, just prepare the new PR).

Rahuljagwani commented 11 months ago

@Rahuljagwani: The CI failed because pull requests from forks do not have access to secrets set up for this repository (this is a security feature by GitHub). I should have thought about this earlier, my apologies.

Two ways to solve this:

I have invited you to our organization. If you clone the repo, create a new feature branch off with git checkout -b pep561, apply your changes, commit, push and then create a PR from the feature branch, the CI should pass and we can merge it. That way you would get full credits for the resulting commit.

Alternatively, I would quickly do it myself and add you as a co-author.

Please let me know how you would like to proceed (or, if you go with option 1, just prepare the new PR).

Understood @uniqueg, I will proceed with the first method. Shortly submitting the PR.