Skip to content

package overhaul#1

Open
nick-youngblut wants to merge 6 commits intokaifuchenlab:mainfrom
nick-youngblut:nick_dev
Open

package overhaul#1
nick-youngblut wants to merge 6 commits intokaifuchenlab:mainfrom
nick-youngblut:nick_dev

Conversation

@nick-youngblut
Copy link

Features added:

  • pyproject.toml
  • CLI install
  • unit tests
  • type hints
  • function docs

I didn't do a lot of testing, but hopefully this gets you a lot closer to production-ready package that can be robustly maintained over time (good software dev practices).

I highly recommend adding a github workflow for continuous integration. Just ask ChatGPT, Claude, etc. on how to do this.

…toml-and-add-type-hints

Switch to pyproject, add typing
- Introduced a .gitignore file to exclude unnecessary files and directories.
- Updated package dependencies in pyproject.toml to specify version constraints.
- Enhanced README.md for clarity and improved formatting.
- Refactored help text in SCIG.py for better readability and organization.
- Added script entry point for SCIG in pyproject.toml.
- Updated README.md to reflect new command usage without changing directories.
- Added detailed docstrings to functions in scig_human_functions.py and scig_mouse_functions.py for better clarity on parameters and return types.
- Refactored SCIG.py to improve argument parsing and help text organization.
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