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

Small updates to documentation and adding .__version__ parameter #332

Merged
merged 5 commits into from
Dec 20, 2024

Conversation

xehu
Copy link
Collaborator

@xehu xehu commented Dec 4, 2024

This pull requests makes some small cosmetic changes to the package:

  1. It updates some of the headings in the "Worked Example" tab of the documentation;
  2. It adds a .version parameter to the package upon installation, per PEP8 guidelines (Expose team_comm_tools.__version__ #318).
  3. It reorders requirements.txt to restore alphabetical order.

@xehu xehu requested a review from sundy1994 December 4, 2024 05:01
@xehu xehu mentioned this pull request Dec 4, 2024
2 tasks
@sundy1994
Copy link
Collaborator

Just to record what we've discussed: having both pyproject.toml and setup.py creates an additional point of maintenance and may cause conflicts in the future. We'd better stick with pyproject.toml as our sole configuration file. Instead, We can directly read the version number from pyproject.toml in init.py:

## __init__.py
from importlib.metadata import version as get_version

__version__ = get_version("team_comm_tools")

## test
>>> import team_comm_tools
>>> print(team_comm_tools.__version__)
>>> '0.1.5'

I'll make this change soon!

@sundy1994 sundy1994 merged commit 4211f0d into dev Dec 20, 2024
1 check passed
@sundy1994 sundy1994 deleted the emily/smallupdates branch December 20, 2024 20:06
sundy1994 added a commit that referenced this pull request Dec 20, 2024
* update examples hierarchy

* Closes #318.

* provide __version__ variable without setup.py

* small fix

---------

Co-authored-by: sundy1994 <[email protected]>
xehu added a commit that referenced this pull request Feb 24, 2025
* add LIWC tests and loading checks

* Small updates to documentation and adding .__version__ parameter (#332)

* update examples hierarchy

* Closes #318.

* provide __version__ variable without setup.py

* small fix

---------

Co-authored-by: sundy1994 <[email protected]>

* update docs in liwc.rst and build again

* Revert "update docs in liwc.rst and build again"

This reverts commit 009d33e.

---------

Co-authored-by: Xinlan Emily Hu <[email protected]>
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