Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adjust small typos, update workflows and dependencies #51

Merged
merged 1 commit into from
Jun 14, 2024
Merged

adjust small typos, update workflows and dependencies #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions {{cookiecutter.project_slug}}/.github/workflows/tag-testpypi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ jobs:
contents: write
steps:
- name: Harden Runner
uses: step-security/harden-runner@a4aa98b93cab29d9b1101a6143fb8bce00e2eac4 # v2.7.1
uses: step-security/harden-runner@17d0e2bd7d51742c71671bd19fa12bdc9d40a3d6 # v2.8.1
with:
egress-policy: audit
- name: Checkout code
uses: actions/checkout@v4
- name: Checkout Repository
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
- name: Create Release
uses: softprops/action-gh-release@69320dbe05506a9a39fc8ae11030b214ec2d1f87 # 2.0.5
env:
Expand Down
7 changes: 3 additions & 4 deletions {{cookiecutter.project_slug}}/CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome. :)
* Remember that this is a volunteer-driven project, and that contributions are welcome. :)

Get Started!
------------
Expand Down Expand Up @@ -85,7 +84,7 @@ Ready to contribute? Here's how to set up ``{{ cookiecutter.project_name }}`` fo

.. code-block:: console

git clone [email protected]:``{{ cookiecutter.github_username }}``/{{ cookiecutter.project_name | replace(' ', '-') }}.git
git clone [email protected]:{{ cookiecutter.github_username }}/{{ cookiecutter.project_name | replace(' ', '-') }}.git

#. Install your local copy into a development environment. {% if cookiecutter.use_conda == 'y' -%}

Expand Down Expand Up @@ -248,7 +247,7 @@ To run specific code style checks:
python -m ruff check {{ cookiecutter.project_slug }} tests
python -m flake8 {{ cookiecutter.project_slug }} tests

To get ``black``, ``isort``, ``blackdoc``, ``ruff``, and ``flake8`` (with plugins ``flake8-alphabetize`` and ``flake8-rst-docstrings``) simply install them with ``pip`` {% if cookiecutter.use_conda == 'y' %}(or ``conda``) {% endif %}into your environment.
To get ``black``, ``isort``, ``blackdoc``, ``ruff``, and ``flake8`` (with the ``flake8-rst-docstrings`` plugin) simply install them with ``pip`` {% if cookiecutter.use_conda == 'y' %}(or ``conda``) {% endif %}into your environment.

Code of Conduct
---------------
Expand Down
8 changes: 6 additions & 2 deletions {{cookiecutter.project_slug}}/docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ Installation
============

..
We strongly recommend installing {{ cookiecutter.project_name }}, in an Anaconda Python environment. Futhermore, due to the complexity of some packages, the default dependency solver can take a long time to resolve the environment. If `mamba` is not already your default solver, consider running the following commands in order to speed up the process:
We strongly recommend installing {{ cookiecutter.project_name }} in an Anaconda Python environment.
Furthermore, due to the complexity of some packages, the default dependency solver can take a long time to resolve the environment.
If `mamba` is not already your default solver, consider running the following commands in order to speed up the process:

.. code-block:: console

Expand Down Expand Up @@ -35,7 +37,7 @@ This is the preferred method to install {{ cookiecutter.project_name }}, as it w
From sources
------------

The sources for {{ cookiecutter.project_name }} can be downloaded from the `Github repo <{{ cookiecutter.__gh_slug}}>`_.
The sources for {{ cookiecutter.project_name }} can be downloaded from the `Github repo`_.

#. Download the source code from the `Github repo`_ using one of the following methods:

Expand Down Expand Up @@ -93,3 +95,5 @@ The sources for {{ cookiecutter.project_name }} can be downloaded from the `Gith
make dev

These commands should work most of the time, but if big changes are made to the repository, you might need to remove the environment and create it again.

.. _Github repo: {{ cookiecutter.__gh_slug}}
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ dev = [
"flake8-rst-docstrings >=0.3.0",
"flit >=3.9.0",
"tox >=4.15.1",
"coverage >=7.0.0",
"coverage >=7.5.0",
"coveralls >=3.3.1",
"mypy",
{%- if cookiecutter.use_pytest == 'y' %}
Expand Down
9 changes: 5 additions & 4 deletions {{cookiecutter.project_slug}}/tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tox]
min_version = 4.0
min_version = 4.15.1
envlist =
lint
py{38,39,310,311,312}
Expand All @@ -9,7 +9,7 @@ envlist =
coveralls
requires =
flit >= 3.9.0
pip >= 23.3.0
pip >= 24.0
opts =
--verbose

Expand All @@ -21,8 +21,9 @@ deps =
blackdoc ==0.3.9
isort ==5.13.2
{%- endif %}
flake8
ruff >=0.3.0
flake8 >=7.0.0
flake8-rst-docstrings >=0.3.0
ruff >=0.4.0
commands =
make lint
allowlist_externals =
Expand Down
Loading