update upstream #11
Open
update upstream #11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* 🎨 add flake8 and ruff line length default (to 90 characters) * 🎨 add formatting of jupyter notebooks per default * 📝 highlight that also a folder has to be renamed * 📝 document what extension are used for * 📝 document debian (ubuntu) package adding which might be needed * 🎨 use PyPI and GitHub integration instead of secret api token * 🙈 hide folders creating when locally building the documentation website * 📝 document desing choices and layout of Python package * 🎨 add copy button for code blocks per default * 🎨 small corrections after proof-reading * 🎨 make name generic and document it. Choose a Licence hint * 🎨 add design document to Sphinx documentation * 🎨 add some more common error checking - set line-length to black default of 88 characters * Apply suggestions from code review Co-authored-by: Copilot <[email protected]> * 🐛 correct python pkg configuration file * 🐛 add missing changes for requirments.txt As noted by Angel using requirements.txt needed one additional change: - add dependencies to the dynamic field Add hint to section with dependencies * 📝 Add hint to GitHub Releases and Source distribution testing * 🎨 follow Pasquale's advices (.gitignore + unnecessary config) - add more to .gitignore and link template - remove line-length configuration as it is already on the default 88 of black formatter * 📝 add sebastians hints on other ressources * 🎨 add license key and remove from classifiers as suggested by Sebastian * 📝 docstring and src layout hints (noted by sebastian) * 🐛 add missing key to pyproject.toml --------- Co-authored-by: Copilot <[email protected]>
* 🎨 format pyproject file * 🐛 fix how line length errors can be ignored (deactivated per default)
* 📝🔧 start adressing recommendations from Sebastian, see #5 * 🎨 add default citation
* 🐛 add mandatory permissiones for trusted publishing * 🎨 move settings for rule to other settings for rule --------- Co-authored-by: Henry Webel <[email protected]>
* 📝 marp to create slides from readme * note pytest.ini for doctest * add function * add tests from demo * ruff lint and format * 🎨 format README.md * rm pres --------- Co-authored-by: Henry Webel <[email protected]>
* 🎨 add sorting check of imports * 🎨 ensure plotly plots are rendered on readthedocs * 🎨 format conf.py * 🎨 apply isort
* 📝🔧 start adressing recommendations from Sebastian, see #5 * 🎨 add default citation
- make sure code stays open source in other projects
* ✨ create a minimal cli interface example * 📝 document command line entry point
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.