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

feat: minimal python project gh repo template #2

Merged
merged 28 commits into from
Sep 16, 2022
Merged

Conversation

pandemicsyn
Copy link

@pandemicsyn pandemicsyn commented Sep 9, 2022

A basic python focused github repo template.

I intialized a basic poetry project so that codeql passes and so that we can ship a basic pytest action.

related to:

@pandemicsyn pandemicsyn changed the title The basics... feat: minimal python project gh repo template Sep 9, 2022
@pandemicsyn pandemicsyn requested review from aaronsteers and a team September 9, 2022 17:26
@pandemicsyn pandemicsyn marked this pull request as ready for review September 9, 2022 17:26
@pandemicsyn
Copy link
Author

@aaronsteers updated the instructions with links to the internal-tech-ops repo for getting github apps installed and incase folks need assistance with permissions.

.pre-commit-config.yaml Outdated Show resolved Hide resolved
tests/__init__.py Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@WillDaSilva WillDaSilva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

I'll be stealing most of this for https://github.com/meltano/cron-ext/

@pandemicsyn
Copy link
Author

👍

I'll be stealing most of this for https://github.com/meltano/cron-ext/

Yea, we should definitely propagate this to the EDK as well. If I was smarter I would have set this up before spinning up airflow-ext, superset-ext, and the edk 😁

Copy link
Member

@WillDaSilva WillDaSilva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Putting a Pytest config in pyproject.toml is probably worth doing. This basic one is good to start, and then projects can expand on it based off of what they need. We may want to set up coverage by default too, but that's a bit more difficult since we need to know the name of the thing we're covering.

pyproject.toml Show resolved Hide resolved
Co-authored-by: Will Da Silva <[email protected]>
Copy link

@aaronsteers aaronsteers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great.

To help with the "Day 2" problem of maintaining existing repos, I think we may want to consider using copier to install the scaffold for new projects. The long-term benefit is that repos could optionally update/upgrade their scaffold as we change this central one.

Opened for further discussion:

@pandemicsyn pandemicsyn merged commit e208f8e into main Sep 16, 2022
@pandemicsyn pandemicsyn deleted the the-basics branch September 16, 2022 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants