New version Python Project template #3
Merged
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
…fore intend a pull request fix: refactor licenses configuration in cookicutter and pyproject.toml. Reduce versbosity and improve maintenance docs: initial commit MkDocs migration for the python-project template. docs: update content of LICENSE for the python-project template chores: remove bash scripts with hooks in the template tests: update placeholder test for the template chores: delete old README.rst and create a new one with different content in markdown docs: update README content, this README belongs to the project not to cookiecutter ci/cd: create workflows for testing, build documentation, security, and quality check docs: update command to run cookiecutter using saezlab organization chores: update minimal test file with __all__ method chores: improve clarity and organization in .pre-commit configuration file chores: include .python-version file in .gitignore chores: remove readthedocs.yaml file chores: improve pyproject.toml file to follow best practices and clear organization fix: exclude workflows of being rendering with jinja2 docs: fix typos in README (cookiecutter template) fix: add instructions for installing pre-commit fix: fix pre-commit versions fix: update Python version specification in workflows and remove unnecessary .python-version from .gitignore fix: correct formatting, errors and other outputs with pre-commit fix: correct formatting, errors and other outputs with pre-commit fix: correct formatting, errors and other outputs with pre-commit fix: correct formatting, errors and other outputs with pre-commit fix: correct formatting, errors and other outputs with pre-commit fix: correct formatting, errors and other outputs with pre-commit fix: correct formatting, errors and other outputs with pre-commit chores: edit badges with updated content
…following best practices
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.
All developments related to this effort are hosted in the docs/mkdocs-migration branch.
✅ Improvements
The template now generates a project with the following features:
Ready-to-use MkDocs Material documentation, following a consistent structure for all Saezlab projects.
GitHub Actions workflows, aligned with best practices:
Improved
pyproject.tomlwith clearly structured sections.Improved
.pre-commit-config.yaml, with a well-organized layout.Simplified setup instructions to create a Python project in just a few steps.
🔜 Next Steps