Skip to content

Conversation

@hakbailey
Copy link
Contributor

@hakbailey hakbailey commented Jul 18, 2022

What does this PR do?

Creates initial Python CLI app structure with all the usual tools already in place for testing, linting/code quality, exception monitoring, logging, Github Actions, etc.

Includes new or updated dependencies?

YES

Developer

  • All new ENV is documented in README (or there is none)
  • Stakeholder approval has been confirmed (or is not needed)

Code Reviewer

  • The commit message is clear and follows our guidelines (not just this pull request message)
  • There are appropriate tests covering any new functionality
  • The documentation has been updated or is unnecessary
  • The changes have been verified
  • New dependencies are appropriate or there were no changes

Why these changes are being introduced:
Since this is a template repository, we want it to have our standard
Python CLI app structure with all the usual tools already in place for
testing, linting/code quality, exception monitoring, logging,
Github Actions, etc.

How this addresses that need:
* Creates basic app folder with initial cli and config modules.
* Creates tests for initial cli and config functionality.
* Adds .github folder with PR template, dependabot configuration, and
  CI workflow.
* Adds Dockerfile set up for basic image creation.
* Adds Makefile with standard dependency management, testing, and
  linting commands.
* Adds Pipfile with initial package and dev dependencies for testing,
  linting, and exception monitoring.
* Adds setup.cfg with initial pytest and linter configurations.
* Adds README with standard dev instructions and an "App setup" section
  at the top with instructions for creating a new app from this
  template.
@hakbailey hakbailey requested a review from ehanson8 July 18, 2022 19:18
Copy link
Contributor

@ehanson8 ehanson8 left a comment

Choose a reason for hiding this comment

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

A lot of good improvements and I think this will make it a lot easier to evolve our practices over time in a more visible way by updating this repo

@hakbailey hakbailey merged commit 2ceafc9 into main Jul 19, 2022
@hakbailey hakbailey deleted the create-repo-structure branch July 19, 2022 15:11
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