wemake-services / wemake-python-package Goto Github PK

It is a really bad experience to have this exception:

» cookiecutter gh:wemake-services/wemake-python-package
You've downloaded /Users/sobolev/.cookiecutters/wemake-python-package before. Is it okay to delete and re-download it? [yes]: yes
project_name [my-awesome-project]: test
organization [wemake.services]: 
project_description [This is how python package should look like!]: test
license [MIT]: 
pyenv: lice: command not found

The `lice' command exists in these Python versions:
  3.8.9

Note: See 'pyenv help global' for tips on allowing both
      python2 and python3 to be found.
32512
ERROR: Stopping generation because post_gen_project hook script didn't exit successfully
Hook script failed (exit status: 1)

We can probably replace source poetry/.../ with echo "::add-path::$HOME/poetry/..."
It can be more simple.

https://docs.pytest.org/en/latest/changelog.html#pytest-6-0-0rc1-2020-07-08

https://github.com/readthedocs/recommonmark#recommonmark

We should switch to myst: https://github.com/executablebooks/MyST-Parser

» cookiecutter gh:wemake-services/wemake-python-package      
project_name [my-awesome-project]: first_project
organization [wemake.services]: x5_school
project_description [This is how python package should look like!]: Test
license [MIT]:   
ERROR: The project slug first_project is not a valid Python module name. Start with a 
lowercase letter. Followed by any lowercase letters, numbers or underscores.
ERROR: Stopping generation because pre_gen_project hook script didn't exit successfull
y
Hook script failed (exit status: 1)

It should be: do not use _ in your project name

Travis should be treated as legacy. Github Actions should be default.

Dependabot couldn't authenticate with https://pypi.python.org/simple/.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

this is a open issue for over a year now:
microsoft/vscode-python#11929
microsoft/vscode-python#11729

May be considering removing it from the boilerplate? or a notice in the doc?
it took me a while to pin point the issue as the traceback was obscure.

https://github.com/wemake-services/wemake-python-package/blob/master/%7B%7Bcookiecutter.project_name%7D%7D/pyproject.toml#L20

repository = "https://github.com/sobolevn/safe-assert"

This should be a cookiecutter variable or unset.

"Easy update process, so your template will always be up-to-date" is listed as a feature. I interpret that as if you made a project with this template, you can update the project to the latest template? Is that true, if so it is not clear how one goes about doing that.

I have stumbled upon this problem with my project https://github.com/python-platonic/documented.

Let me quote the piece of .github/workflows/test.yml, annotated with the printout.

    - name: Run checks
      run: |
        source "$HOME/.poetry/env"

        find "$HOME" -name "mypy" -print
        # /home/runner/work/documented/documented/.venv/lib/python3.8/site-packages/mypy
        # /home/runner/work/documented/documented/.venv/bin/mypy

        echo $PATH
        # /home/runner/.poetry/bin:/opt/hostedtoolcache/Python/3.8.5/x64/bin:/opt/hostedtoolcache/Python/3.8.5/x64:/home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin:/usr/share/rust/.cargo/bin:/home/runner/.config/composer/vendor/bin:/home/runner/.dotnet/tools:/snap/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin

        make test
        # mypy documented tests/*.py
        # bash: mypy: command not found
        # make: *** [lint] Error 127

mypy command is in /home/runner/work/documented/documented/.venv/bin/, which is not in PATH.

Consider to make the ./docs/Makefile targets available in ./Makefile. For example like this:

.PHONY: html
html:
        cd docs && $(MAKE) html

However I have not figured out a way to make all ./docs/Makefile targets available without to much boilerplate ;-(
That did not help either: "Managing Large Projects" with make: https://www.oreilly.com/library/view/managing-projects-with/0596006101/ch06.html

Dependabot couldn't authenticate with https://pypi.python.org/simple/.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

We will be able to move doc dependecies to a separate group: https://python-poetry.org/blog/announcing-poetry-1.2.0a2/

Maybe we don't need to run poetry install if cache worked.

      - run: poetry install
        if: steps.cache.outputs.cache-hit != 'true'

https://github.com/schemathesis/schemathesis/blob/master/.github/workflows/scheduled.yml#L40

For example, this

from typing import Dict, Iterable, List, Mapping, MutableMapping, NewType, Sequence, Set,  TypeVar

is turned into this:

from typing import (
  Dict,
  Iterable,
  List,
  Mapping,
  MutableMapping,
  NewType,
  Sequence,
  Set,
  TypeVar,
)

If to keep the rule to always use a space count divisible by 4 for indentation, that is annoying.

We need this file https://github.com/dry-python/returns/blob/master/.github/workflows/test.yml to be sync to the older version in this file: https://github.com/wemake-services/wemake-python-package/blob/master/.github/workflows/test.yml

Without some specific hacks we have for better speed.

How about also add docker and docker compose file to project to be able to user docker interpreter and/or if your package is intend to run under docker?