feat: program able to return installed version and help at startup

[sbillinge]

closes #192
closes #193

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.35%. Comparing base (41a2788) to head (2517751).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #215   +/-   ##
=======================================
  Coverage   82.35%   82.35%           
=======================================
  Files           5        5           
  Lines          85       85           
=======================================
  Hits           70       70           
  Misses         15       15           

[ludivintchokote]

Greetings @sbillinge,
I added your changes locally and tried running the code with the --version argument. i had a circular import error. I attached the image of the output file below

[ludivintchokote]

Logically what you added should give, but even without the code in that main.py doesn't run due to the import error previously stated.

[sbillinge]

Thanks for this. @ludivintchokote did you try running pytentiostat --version? This fix is supposed to work when someone runs the app itself. Do you still get that error? This is what I am getting:

[ludivintchokote]

Yeah i did, in my case running the command opened an empty text file named "--version"

…

On Mon, Jan 27, 2025, 13:37 Simon Billinge ***@***.***> wrote: Thanks for this. @ludivintchokote <https://github.com/ludivintchokote> did you try running pytentiostat --version? This fix is supposed to work when someone runs the app itself. Do you still get that error? — Reply to this email directly, view it on GitHub <#215 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BNJCXPCNHMUG7FVPQ4YTC432MYR67AVCNFSM6AAAAABV5AGSCKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJVGY2DQMJSHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[ludivintchokote]

I think the codes needs to be updated as well to be compatible with the recent version of libraries. Some lines of codes have attribute reference errors for some classes. And it makes it very difficult to write tests for the codes without the test failing On Mon, Jan 27, 2025, 17:56 Ludivin Tchokote ***@***.***> wrote:

…

Yeah i did, in my case running the command opened an empty text file named "--version" On Mon, Jan 27, 2025, 13:37 Simon Billinge ***@***.***> wrote: > Thanks for this. @ludivintchokote <https://github.com/ludivintchokote> > did you try running pytentiostat --version? This fix is supposed to work > when someone runs the app itself. Do you still get that error? > > — > Reply to this email directly, view it on GitHub > <#215 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/BNJCXPCNHMUG7FVPQ4YTC432MYR67AVCNFSM6AAAAABV5AGSCKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJVGY2DQMJSHA> > . > You are receiving this because you were mentioned.Message ID: > ***@***.***> >

[sbillinge]

Yeah i did, in my case running the command opened an empty text file named "--version"
…
On Mon, Jan 27, 2025, 13:37 Simon Billinge @.> wrote: Thanks for this. @ludivintchokote https://github.com/ludivintchokote did you try running pytentiostat --version? This fix is supposed to work when someone runs the app itself. Do you still get that error? — Reply to this email directly, view it on GitHub <#215 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/BNJCXPCNHMUG7FVPQ4YTC432MYR67AVCNFSM6AAAAABV5AGSCKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJVGY2DQMJSHA . You are receiving this because you were mentioned.Message ID: @.>

it looks as if you maybe don't have the package installed correctly. Please can you copy-paste the commands you used to set up your virtual environment?

[ludivintchokote]

Yeah we used the command "pip install pytentiostat"

…

On Mon, Jan 27, 2025, 18:10 Simon Billinge ***@***.***> wrote: Yeah i did, in my case running the command opened an empty text file named "--version" … <#m_7598647474511257146_> On Mon, Jan 27, 2025, 13:37 Simon Billinge *@*.*> wrote: Thanks for this. @ludivintchokote <https://github.com/ludivintchokote> https://github.com/ludivintchokote <https://github.com/ludivintchokote> did you try running pytentiostat --version? This fix is supposed to work when someone runs the app itself. Do you still get that error? — Reply to this email directly, view it on GitHub <#215 (comment) <#215 (comment)>>, or unsubscribe https://github.com/notifications/unsubscribe-auth/BNJCXPCNHMUG7FVPQ4YTC432MYR67AVCNFSM6AAAAABV5AGSCKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJVGY2DQMJSHA <https://github.com/notifications/unsubscribe-auth/BNJCXPCNHMUG7FVPQ4YTC432MYR67AVCNFSM6AAAAABV5AGSCKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJVGY2DQMJSHA> . You are receiving this because you were mentioned.Message ID: @.*> it looks as if you maybe don't have the package installed correctly. Please can you copy-paste the commands you used to set up your virtual environment? — Reply to this email directly, view it on GitHub <#215 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BNJCXPBMQDG5NZYKW54WCED2MZR6XAVCNFSM6AAAAABV5AGSCKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJWGM4TKNZUHE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[ludivintchokote]

I tried uninstalling the package and reinstalling it again. Below is the output I get

[ludivintchokote]

even when i try installing it specifying the version name. it gives the following error

[ludivintchokote]

Thanks for this. @ludivintchokote did you try running pytentiostat --version? This fix is supposed to work when someone runs the app itself. Do you still get that error? This is what I am getting:

Good it works there!

[sbillinge]

@ludivintchokote since we are developing on the code you have to install it in editable mode or you won't be testing the latest version. i.e., install by first going to the .../pytentiostat/ directory and then typing pip install -e .

[ludivintchokote]

@SimonBillinge I tried that but it installed the version 0.0.1. The url I provide after the pip install -e, should it be the local link or the online one?

…

On Tue, Jan 28, 2025, 11:37 Simon Billinge ***@***.***> wrote: @ludivintchokote <https://github.com/ludivintchokote> since we are developing on the code you have to install it in editable mode or you won't be testing the latest version. i.e., install by first going to the .../pytentiostat/ directory and then typing pip install -e . — Reply to this email directly, view it on GitHub <#215 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BNJCXPBVNGXXHWYLD5NXYI32M5MX5AVCNFSM6AAAAABV5AGSCKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJYGYYTMNRXGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[sbillinge]

…

The -e installs the package in your environment in editable mode, which means that when you run it, it runs the version that it finds checked out on your local hard-drive. This means you can make edits or check out a different branch and rerun the code and it will run the latest vesrsion you have checked out. We use this for development. This does not have a "version" per se because it is changing dynamically. So when we run the version() function, it just goes and gets the latest version number it knows about. In my case it was 0.0.5. I am not sure why you are getting 0.0.1. It may make sense for you to make a clean checkout of everything and build a new virtual environment and paste into the comment thread all the coomands and what you get back and we can maybe get to the bottom of what is going on.