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

Overhauled packaging and testing #13

Merged
merged 1 commit into from
Oct 24, 2024
Merged

Conversation

agronholm
Copy link
Contributor

  • Migrated from setup.py to pyproject.toml
  • Added automated GitHub Action CI based testing
  • Migrated publishing workflow to use Trusted Publishing
  • Moved test dependencies from requirements.txt to pyproject.toml (under the test extra)
  • Removed metadata in tkreload/__init__.py as no longer needed (no tools uses these)
  • Adopted setuptools_scm to handle versioning (based on git tags) and file inclusion (based on what's in the repository)
  • Defined Python 3.9 as the minimum requirement, as the test dependencies won't install on earlier Pythons
  • Renamed README.MD files to README.md for consistency

@iamDyeus iamDyeus added documentation Improvements or additions to documentation hacktoberfest labels Oct 24, 2024
@iamDyeus
Copy link
Owner

Thanks for the Contributions @agronholm 🥳

@iamDyeus iamDyeus merged commit 878f957 into iamDyeus:main Oct 24, 2024
0 of 6 checks passed
@agronholm agronholm deleted the overhaul branch October 24, 2024 07:44
@agronholm
Copy link
Contributor Author

I mistakenly included Python 3.8 in the test workflow; you'll need to delete that. The rest fail because they seem to require a Windows-specific module.

@agronholm
Copy link
Contributor Author

One more thing: you have to configure trusted publishing from the PyPI side too: https://docs.pypi.org/trusted-publishers/adding-a-publisher/

@iamDyeus
Copy link
Owner

One more thing: you have to configure trusted publishing from the PyPI side too: https://docs.pypi.org/trusted-publishers/adding-a-publisher/

Yeah, I configured that when pushed the v1.0.2 tag.

@iamDyeus
Copy link
Owner

I mistakenly included Python 3.8 in the test workflow; you'll need to delete that. The rest fail because they seem to require a Windows-specific module.

I'll remove Python 3.8 from the test workflow, will need to look into the Windows-specific module one though.

@agronholm
Copy link
Contributor Author

It seems like you're using msvcrt for keyboard handling?

@iamDyeus
Copy link
Owner

I see, we shifted from keyboard module to sys.in in #6, but I may have accidentally bumped it to msvcrt in one of the recent commits.

@agronholm
Copy link
Contributor Author

This is the commit that introduced msvcrt to main.py.

@iamDyeus
Copy link
Owner

This is the commit that introduced msvcrt to main.py.

got it thanks! will fix this soon

@iamDyeus
Copy link
Owner

One more question: you removed the requirements.txt in your PR. I was wondering, how are people supposed to run it in a dev environment without a requirements file? Will they need to create a new build every time they try to do something?

@agronholm
Copy link
Contributor Author

No, they'd just install it in editable mode: pip install -e .[test]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants