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

build: clean up project configuration #41

Merged
merged 10 commits into from
Nov 9, 2023

Conversation

alohamora
Copy link
Contributor

Description

Move config for the following tools to pyproject.toml

  1. mypy
  2. coverage
  3. flake8

Move project metadata defined in setup.py to pyproject.toml
Fixes #39

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

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
  • 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
  • I have added docstrings following the Python style guidelines of this project to all new modules, classes, methods and functions are documented with docstrings following; I have updated any previously existing docstrings, if applicable
  • I have updated any sections of the app's documentation that are affected by the proposed changes, if applicable

@codecov
Copy link

codecov bot commented Oct 28, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (dc32e2a) 100.00% compared to head (6addc0e) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##               dev       #41   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         5    -1     
  Lines          190       189    -1     
=========================================
- Hits           190       189    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

cloud_registry/version Outdated Show resolved Hide resolved
setup.cfg Outdated Show resolved Hide resolved
Copy link
Contributor

@kushagra189 kushagra189 left a comment

Choose a reason for hiding this comment

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

Require some context here for pyproject.toml context. Is this specific to cloud-registry or can we export it using foca and use it across other repositories? Want the reasoning for this migration for my understanding.

cloud_registry/version Outdated Show resolved Hide resolved
setup.cfg Outdated Show resolved Hide resolved
setup.cfg Outdated Show resolved Hide resolved
@alohamora
Copy link
Contributor Author

@uniqueg can you please review this PR

@uniqueg uniqueg changed the title build: migrate project metadata and tool configs to pyproject.toml build: clean up project configuration Nov 9, 2023
Copy link
Member

@uniqueg uniqueg left a comment

Choose a reason for hiding this comment

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

Thanks a lot. LGTM. Happy to merge it as is, but if you like, you can update the version and/or use the drop in package for Flake8 pyproject.toml support (see comments). Up to you.

docs/api/conf.py Outdated Show resolved Hide resolved
setup.cfg Outdated Show resolved Hide resolved
@alohamora
Copy link
Contributor Author

yes, I have tried out the package. It works fine with no changes required in the config format. will integrate both of the above mentioned changes in the PR

@alohamora
Copy link
Contributor Author

@uniqueg can you please have a look at the PR again, there have been dependency changes due to connexion's new release as well.

@alohamora alohamora merged commit b742271 into dev Nov 9, 2023
6 checks passed
@alohamora alohamora deleted the build/migrate-metadata-pyproject branch November 9, 2023 16:36
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.

build: move project metadata to pyproject.toml
3 participants