Template Repository for pyXLMS projects

A template repository for python scripts and projects using pyXLMS.

Checklist

• Use uv for python project and dependency management.
• Write your code in main.py or any other python file.
• [Optionally] setup tests in tests/.
• Replace data in data with your own data [or delete if you don't have data].
• Setup your CITATION.cff according to your needs [or delete file].
• Replace copyright name in LICENSE and/or choose a different license.
• Add your requirements to requirements.txt.
• Adjust this README.md to your needs!

Getting Help

• Help for pyXLMS: github.com/hgb-bin-proteomics/pyXLMS
• Help for this template:
  • uv: Python project and dependency management.
  • ruff: Python linter and formatter.
  • pyright: Python type checker.
  • pytest: Python testing suit.
  • GitHub Actions: Used for running the above automatically.
  • You may also want to check out this template which was used as a basis.
• Contact: micha.birklbauer@fh-hagenberg.at

Important

The below sections should be adjusted and updated by you!

Known Issues

List of known issues

Citing

If you are using PLACEHOLDER please cite:

Very important title
Important Author, and Another Important Author
Journal of Cool Stuff 2023 12 (3), 4567-4589
DOI: 12.3456/cool-stuff

License

• MIT

Contact

• your.mail@mail.com