Skip to content

Commit

Permalink
Merge branch 'main' of github.com:NLeSC/python-template into line-length
Browse files Browse the repository at this point in the history
  • Loading branch information
bouweandela committed Aug 28, 2024
2 parents b980d4f + 953db45 commit 3e89571
Show file tree
Hide file tree
Showing 11 changed files with 61 additions and 67 deletions.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/01_bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**

- Template profile
- [ ] recommended
- [ ] minimum
- [ ] let me choose
- OS:
<!-- run this command: uname -a -->
- version:
Expand Down
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/10_generated_package.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ labels: generated-package
assignees: ''

---

## Checklist before submitting an issue

- [ ] I have checked the [existing issues](https://github.com/NLeSC/python-template/issues) and couldn't find an issue about this bug.

## Issue details
<!--
Whatever you write here must have something to do with the code you get from running `copier`.
-->
8 changes: 7 additions & 1 deletion .github/ISSUE_TEMPLATE/20_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ labels: template
assignees: ''

---

## Checklist before submitting an issue

- [ ] I have checked the [existing issues](https://github.com/NLeSC/python-template/issues) and couldn't find an issue about this bug.

## Issue details
<!--
Whatever you write here must have something to do with the code of the template itself, i.e. before you run `copier`.
Whatever you write here must have something to do with the code you get from running `copier`.
-->
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/30_blank.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,12 @@ labels: ''
assignees: ''

---

## Checklist before submitting an issue

- [ ] I have checked the [existing issues](https://github.com/NLeSC/python-template/issues) and couldn't find an issue about this bug.

## Issue details
<!--
Whatever you write here must have something to do with the code you get from running `copier`.
-->
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
* Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)

### Changed
* next_steps.md is shown as a copier message [#609](https://github.com/NLeSC/python-template/pull/609)
* Change the default profile to 'recommended' [#598](https://github.com/NLeSC/python-template/pull/598)
* Updated the user documentation (README.md) of the template [#569](https://github.com/NLeSC/python-template/pull/569)
* Droped Python 3.8 and 3.9 support [#551](https://github.com/NLeSC/python-template/pull/551)
* Fix broken link checker [#546](https://github.com/NLeSC/python-template/pull/546)
Expand All @@ -25,7 +27,7 @@
* Restored default line-length of 79 characters, as recommended by [PEP-8](https://peps.python.org/pep-0008/#maximum-line-length) [#389](https://github.com/NLeSC/python-template/pull/389)

### Removed

* Remove the configuration of isort ([#591](https://github.com/NLeSC/python-template/pull/591)), which is no longer used since [#347](https://github.com/NLeSC/python-template/issues/347).

## [0.5.0]

Expand Down
34 changes: 29 additions & 5 deletions copier/messages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,39 @@ _message_before_copy: |
input to each of them.
_message_after_copy: |
Your project "{{ package_name }}" has been created successfully!
Your project "{{ package_name }}" has been successfully created in {{ _copier_conf.dst_path }} folder!
Next steps:
{% if template_profile != 'minimum' -%}
1. Change directory to the project root:
Next steps:
$ cd {{ _copier_conf.dst_path }}
- Below are the commands to put your Python package under using git:
2. Read next_steps.md which contains information on next steps.
cd {{ _copier_conf.dst_path }}
git init
git add --all
git commit -m "first commit"
git branch -M main
git remote add origin {{ repository }}
- Push the initial commit to a new repo on GitHub
Go to https://github.com/organizations/{{github_organization}}/repositories/new
and create a new repository named `{{ package_name }}` as an empty repository, then push your commits to GitHub:
git push --set-upstream origin main
{% if AddDevDoc -%}
- Project development documentation
The README.dev.md contains developer documentation
{%- endif %}
- Project layout explained
For an explanation of what files are there, and what each of these do, please refer to {{ _copier_conf.dst_path }}/project_setup.md
{%- endif-%}
_message_before_update: |
Thanks for updating your project using our template.
Expand Down
2 changes: 1 addition & 1 deletion copier/profiles.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# profile selection
template_profile:
type: str
default: ask
default: "recommended"
help: Select a profile
choices:
Recommended (our defaults for research software): "recommended"
Expand Down
2 changes: 1 addition & 1 deletion copier/questions/package_details.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ email:
{% endif %}
code_of_conduct_email:
type: str
placeholder: [email protected]
default: "{{ email }}"
help: What is the email address for code of conduct?
when: "{{ template_profile != 'minimum' and AddPackageDetails }}"
validator: >-
Expand Down
2 changes: 1 addition & 1 deletion template/docs/conf.py.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ author = u"{{ full_name|replace('\"', '\\\"') }}"
# built documents.
#
# The short X.Y version.
version = "0.1.0"
version = "{{ version }}"
# The full version, including alpha/beta/rc tags.
release = version

Expand Down
49 changes: 0 additions & 49 deletions template/next_steps.md.jinja

This file was deleted.

8 changes: 0 additions & 8 deletions template/pyproject.toml.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,6 @@ branch = true
source = ["src/{{ package_name }}"]
command_line = "-m pytest"

[tool.isort]
lines_after_imports = 2
force_single_line = 1
no_lines_before = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"]
known_first_party = "{{ package_name }}"
src_paths = ["src/{{ package_name }}", "tests"]
line_length = 120

[tool.tox]
legacy_tox_ini = """
[tox]
Expand Down

0 comments on commit 3e89571

Please sign in to comment.