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

Issue and PR template updates, adding Black and isort, and removing broken _get_commit_hash() implementation #25

Merged
merged 8 commits into from
Mar 19, 2024

Conversation

mrl280
Copy link
Collaborator

@mrl280 mrl280 commented Mar 19, 2024

Description:

  • Issue and PR template updates: Removing checklists and making making text invisible.
  • Adding Black and isort configuration, dependency group, and applying their style fixes to the existing source.
  • Removed the broken _get_commit_hash() implementation, and added the Python version to the print_version_info() function.

New output of the print_version_info() function. Notice the Python version has been added and the git commit hash can't be resolved:

Type "help", "copyright", "credits" or "license" for more information.
>>> import ria
>>> ria.print_version_info()

RIA Core Version: 0.1.2
Python Version: 3.10.11

SYSTEM
------
commit              : COULD NOT RESOLVE
python              : 3.10.11.final.0
python-bits         : 64
OS                  : Windows
OS-release          : 10
Version             : 10.0.22631
machine             : AMD64
processor           : Intel64 Family 6 Model 140 Stepping 1, GenuineIntel
byteorder           : little
LC_ALL              : None
LANG                : None
LOCALE              : {'language-code': 'English_Canada', 'encoding': '1252'}

CUDA
----
available           : False
device              : None
version             : None
count               : None
index               : None

DEPENDENCIES
------------
matplotlib          : 3.8.3
torch               : 2.2.1
numpy               : 1.26.4
pandas              : 2.2.1
click               : 8.1.7
dateutil            : COULD NOT RESOLVE
poetry              : COULD NOT RESOLVE
pip                 : 24.0
pytest              : COULD NOT RESOLVE
sphinx              : 7.2.6
sphinx-rtd-theme    : 2.0.0
sphinx-autobuild    : COULD NOT RESOLVE
flake8              : 7.0.0
black               : COULD NOT RESOLVE
isort               : COULD NOT RESOLVE

Please include the above version information in all bug reports.

Related Issues:
#23

Outstanding Sub-Issues:
#23 : _get_commit_hash() function is not yet implemented, but I did remove the broken implementation.

Tips for the Reviewer:
Have a look through the proposed changes, but no need to install or run anything.

Hardware/Driver Requirements:
None.

Checklist:
Please be sure to check all boxes honestly. This is to ensure a smooth development process, and to reduce the
likelihood of needing to make additional changes later on.

  • I understand that changes authored by individuals who have not signed a Contributor License Agreement (CLA),
    or whose authorship we cannot verify, may not be accepted.
  • These contribution address a triaged issue.
  • I have performed a self-review of my code and my changes generate no new warnings.
  • I have included unit tests for my code contributions, and all tests are passing.
  • The docstrings are complete, include doctests demonstrating usage, and are properly formatted.
    I have verified that any updates to the project documentation are complete and look okay.
  • I have confirmed all my code contributions are formatted in accordance with the project's Flake8 style
    configuration.
  • No unnecessary changes have been made to the Poetry lock file, but pyproject.toml and the Poetry lock file
    have been updated to reflect any dependency changes.
  • I acknowledge that upon the submission of this pull request, Qoherent will assume the copyright for this
    contribution.

A heartfelt thank you from everyone at Qoherent and the broader radio community for taking the time to contribute to
RIA Core. 🙏💖 <- This thank you note will be invisible in future PRs

@mrl280 mrl280 requested a review from abeigi March 19, 2024 02:22
Copy link
Contributor

@abeigi abeigi left a comment

Choose a reason for hiding this comment

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

reviewed and approved

@abeigi abeigi merged commit 6549576 into main Mar 19, 2024
@abeigi abeigi deleted the template-updates branch March 19, 2024 02:51
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.

2 participants