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.

Sign up for GitHub

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

Jump to bottom

Python project best practices #2

Open
ryanpdx opened this issue Nov 15, 2023 · 0 comments
Open

Python project best practices #2

ryanpdx opened this issue Nov 15, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@ryanpdx
Copy link
Member

ryanpdx commented Nov 15, 2023 •
edited
Loading

Some python project best practices

  • Add a requirements.txt. It allows developers to quickly install all needed dependencies for this project (see an example in oresat-c3-software)
  • Add a pyproject.toml with black, isort, pylama, mypy, pytlint configs (can mostly copy from oresat-c3-software)
  • Lint the code with pylama and fix all issues
  • Autoformat with black and isort
  • Add GitHub workflow configs to run black, isort, unittest, pylama, etc
@ryanpdx ryanpdx added the enhancement New feature or request label Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
Test Support Equipment
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ryanpdx