Skip to content

Fix some small rendering issues. #20

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.

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

Merged
merged 5 commits into from
May 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
exclude: |
(?x)^(
{{cookiecutter.project_slug}}/tests/test_import.py
)$

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.2.0
Expand Down Expand Up @@ -71,7 +76,9 @@ repos:
--fail-under=40,
--config,
pyproject.toml,
"{{cookiecutter.project_slug}}"
"{{cookiecutter.project_slug}}",
--exclude,
"{{cookiecutter.project_slug}}/tests/test_import.py"
]
pass_filenames: false
- repo: https://github.com/executablebooks/mdformat
Expand Down
6 changes: 5 additions & 1 deletion docs/source/changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
This is a record of all past cookiecutter-pytask-project releases and what went into
them in reverse chronological order.

## 1.2.0 - 2022-xx-xx
## 1.2.1 - 2022-05-13

- {pull}`20` fixes some small rendering issues.

## 1.2.0 - 2022-04-14

- {pull}`7` skips concurrent CI builds.
- {pull}`8` harmonizes cookiecutter-pytask-project with econ-project-templates.
Expand Down
11 changes: 10 additions & 1 deletion tests/test_cookie.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,21 @@ def test_check_conda_environment_creation_and_run_all_checks(cookies):
check=True,
)

# Test building documentation
# Install package.
subprocess.run(
("conda", "run", "-n", "__test__", "pip", "install", "-e", "."),
cwd=result.project_path,
check=True,
)

# Run tests.
subprocess.run(
("conda", "run", "-n", "__test__", "pytest"),
cwd=result.project_path,
check=True,
)

# Test building documentation
subprocess.run(
("conda", "run", "-n", "__test__", "make", "html"),
cwd=result.project_path / "docs",
Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/CITATION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
@Unpublished{{ "{" }}{{ cookiecutter.project_slug }}{% now 'local', '%Y' %},
Title = {{ "{" }}A Python tool for managing scientific workflows.{{ "}" }},
Title = {{ "{" }}{{ cookiecutter.project_description }}{{ "}" }},
Author = {{ "{" }}{{ cookiecutter.author }}{{ "}" }},
Year = {{ "{" }}{% now 'local', '%Y' %}{{ "}" }},
Url = {{ "{" }}https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}{{ "}" }}
Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
include CITATION
{% if cookiecutter.open_source_license == 'Not open source' %}include LICENSE
{% if cookiecutter.open_source_license != 'Not open source' %}include LICENSE
{% endif %}
exclude *.yaml
exclude *.yml
Expand Down
12 changes: 4 additions & 8 deletions {{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,19 @@ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/main)

To get started, create the environment with

.. code-block:: console

```
```console
$ conda/mamba env create
```

To build the project, type

.. code-block:: console

```
```console
$ pytask
```

## Credits

This project was created with `cookiecutter <https://github.com/audreyr/cookiecutter>`\_
This project was created with [cookiecutter](https://github.com/audreyr/cookiecutter)
and the
`cookiecutter-pytask-project <https://github.com/pytask-dev/cookiecutter-pytask-project>`\_
[cookiecutter-pytask-project](https://github.com/pytask-dev/cookiecutter-pytask-project)
template.
10 changes: 5 additions & 5 deletions {{cookiecutter.project_slug}}/setup.cfg
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[metadata]
name = {{ cookiecutter.project_slug }}
description = A project with pytask.
long_description = file: README.rst
long_description_content_type = text/x-rst
description = {{ cookiecutter.project_description }}
long_description = file: README.md
long_description_content_type = text/markdown
url = hhttps://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}
author = {{ cookiecutter.author }}
author_email = {{ cookiecutter.email }}
license = {{ cookiecutter.open_source_license }}
license_file = LICENSE
platforms = unix, linux, osx, cygwin, win32
{% if cookiecutter.open_source_license != 'Not open source' %}license_file = LICENSE
{% endif %}platforms = unix, linux, osx, cygwin, win32
classifiers =
Intended Audience :: Science/Research
License :: OSI Approved :: {{ cookiecutter.open_source_license }} License
Expand Down
7 changes: 7 additions & 0 deletions {{cookiecutter.project_slug}}/tests/test_import.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from __future__ import annotations

import {{ cookiecutter.project_slug }}


def test_import():
assert hasattr({{ cookiecutter.project_slug }}, "__version__")