Skip to content

Commit

Permalink
perf(project information): adding missing information (#149)
Browse files Browse the repository at this point in the history
  - Description using the one given via TUI in `pyproject.toml`
  - Adding `packages` entry in `pyproject.toml`
  - Fix a block with wrong indentation in the release workflow in the template
  • Loading branch information
YurelyCamacho authored Jul 20, 2023
1 parent 321417b commit 76ee498
Show file tree
Hide file tree
Showing 9 changed files with 278 additions and 232 deletions.
2 changes: 1 addition & 1 deletion conda/dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ dependencies:
- nodejs
- compilers
- pip:
- makim==1.8.1
- makim==1.8.2
448 changes: 229 additions & 219 deletions poetry.lock

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ include = [
python = "^3.8.1"
cookieninja = "1.0.0"
sh = "^2.0.4"
pyyaml = ">=5"
colorama = "^0.4.6"
inquirer = "^3.1.3"
pyyaml = ">=6.0.1"

[tool.poetry.group.dev.dependencies]
pytest = ">=7"
Expand All @@ -34,7 +34,7 @@ Sphinx = ">=4.4"
jupyterlab = ">=3.5.1"
jupyter-book = ">=0.12.3"
myst-parser = ">=0.15"
makim = "1.8.1"
makim = "1.8.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
Expand Down
2 changes: 1 addition & 1 deletion src/scicookie/cookiecutter.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"project_name": "OSL Python package",
"project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}",
"package_slug": "{{ cookiecutter.project_slug.lower().replace('-', '_') }}",
"project_short_description": "OSL Python Package contains all the boilerplate you need to create a Python package.",
"project_short_description": "This Project aims to ...",
"project_version": "0.1.0",
"project_url": "https://{{ cookiecutter.project_slug }}.com",
"project_license": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ jobs:
- uses: actions/checkout@v3

- uses: conda-incubator/setup-miniconda@v2
with:
miniconda-version: "latest"
mamba-version: "1.*"
environment-file: conda/dev.yaml
channels: conda-forge,nodefaults
channel-priority: true
activate-environment: {{ cookiecutter.project_slug }}
use-mamba: true
miniforge-variant: Mambaforge
with:
miniconda-version: "latest"
mamba-version: "1.*"
environment-file: conda/dev.yaml
channels: conda-forge,nodefaults
channel-priority: true
activate-environment: {{ cookiecutter.project_slug }}
use-mamba: true
miniforge-variant: Mambaforge

- name: Install deps
run: poetry install
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ authors = [
{ name = "{{ cookiecutter.author_full_name }}", email = "{{ cookiecutter.author_email }}" },
]
description = "{{ cookiecutter.project_short_description }}"
{% if cookiecutter.project_layout == "src" -%}
packages = [
{include = "{{ cookiecutter.package_slug }}", from="src"},
]
{% else -%}
packages = [
{include = "{{ cookiecutter.package_slug }}"},
]
{% endif -%}
readme = "README.md"
classifiers = [
"Development Status :: 1 - Planning",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ description = "{{ cookiecutter.project_short_description }}"
authors = [
{ name = "{{ cookiecutter.author_full_name }}", email = "{{ cookiecutter.author_email }}" },
]
{% if cookiecutter.project_layout == "src" -%}
packages = [
{include = "{{ cookiecutter.package_slug }}", from="src"},
]
{% else -%}
packages = [
{include = "{{ cookiecutter.package_slug }}"},
]
{% endif -%}
readme = "README.md"
classifiers = [
"Development Status :: 1 - Planning",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ description = "{{ cookiecutter.project_short_description }}"
authors = [
{ name = "{{ cookiecutter.author_full_name }}", email = "{{ cookiecutter.author_email }}" },
]
{% if cookiecutter.project_layout == "src" -%}
packages = [
{include = "{{ cookiecutter.package_slug }}", from="src"},
]
{% else -%}
packages = [
{include = "{{ cookiecutter.package_slug }}"},
]
{% endif -%}
readme = "README.md"
classifiers = [
"Development Status :: 1 - Planning",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@ name = "{{ cookiecutter.project_slug }}"
version = "{{ cookiecutter.project_version }}" # semantic-release
description = "{{ cookiecutter.project_short_description }}"
authors = ["{{ cookiecutter.author_full_name }} <{{ cookiecutter.author_email }}>"]
{% if cookiecutter.project_layout == "src" -%}
packages = [
{include = "{{ cookiecutter.package_slug }}", from="src"},
]
{% else -%}
packages = [
{include = "{{ cookiecutter.package_slug }}"},
]
{% endif -%}
license = "{{ cookiecutter.project_license }}"
exclude = [
".git/*",
Expand Down

0 comments on commit 76ee498

Please sign in to comment.