Skip to content

Add setup.py for easy installation and usage - #4

Open
francisco-dlp wants to merge 13 commits into
M4I-nanoscopy:masterfrom
francisco-dlp:setup
Open

Add setup.py for easy installation and usage#4
francisco-dlp wants to merge 13 commits into
M4I-nanoscopy:masterfrom
francisco-dlp:setup

Conversation

@francisco-dlp

@francisco-dlp francisco-dlp commented Mar 25, 2022

Copy link
Copy Markdown

I have added a setup.py file for easy installation. It enables using tpx3HitParser from anywhere without adding the installation folder to PATH. For that I've slightly changed the package structure and import style.

Example of usage:

tpx3hitparser --raw fDcp_000000.tpx3 -o test.hdf5

I have also updated .gitignore with GitHub's Python one.

@PaulVanSchayck

Copy link
Copy Markdown
Member

Thanks for this PR, and sorry for not getting back to you sooner. You're right, using a proper setup.py is in this day and age a much cleaner way to handle a package like this.

I've got a couple of changes on top of your commits. I'll push those soon.

One question. Is it just a typo, or intentional that you prefer tp3hitparser over tpx3hitparser?

@francisco-dlp

Copy link
Copy Markdown
Author

That was a typo, sorry.

Are you still considering merging this PR?

@PaulVanSchayck

Copy link
Copy Markdown
Member

Yes.. I would. Would you have time to update the PR, and fix the typo?

@francisco-dlp

Copy link
Copy Markdown
Author

Done.

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