johanvergeer / cookiecutter-poetry Goto Github PK

View Code? Open in Web Editor NEW

This project forked from audreyfeldroy/cookiecutter-pypackage

9.0 1.0 16.0 679 KB

Cookiecutter template for a Python package.

License: MIT License

Makefile 4.62% Python 91.87% Batchfile 3.51%

cookiecutter-poetry's Introduction

Cookiecutter Poetry

Cookiecutter template for a Python package.

GitHub repo: https://github.com/johanvergeer/cookiecutter-poetry/
Documentation: https://cookiecutter-poetry.readthedocs.io/
Free software: MIT license

Features

Testing setup with pytest
Github Actions: Ready for GitHub actions
Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
Auto-release to PyPI when you push a new tag to master (optional)
Command line interface using Click (optional)
GitHub Issue templates for bug reports and feature requests

Quickstart

Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):

pip install -U cookiecutter

Generate a Python package project:

cookiecutter https://github.com/johanvergeer/cookiecutter-poetry.git

Then:

Create a repo and put it there.
Create virtual environment and install project dependencies. (poetry install)
Run the Travis CLI command travis encrypt --add deploy.password to encrypt your PyPI password in Travis config and activate automated deployment on PyPI when you push a new tag to master branch.
Add the repo to your ReadTheDocs account + turn on the ReadTheDocs service hook.
Release your package by pushing a new tag to master.

For more details, see the cookiecutter-poetry tutorial.

Fork This / Create Your Own

If you have differences in your preferred setup, I encourage you to fork this to create your own version. Or create your own; it doesn't strictly have to be a fork.

Once you have your own version working, add it to the Similar Cookiecutter Templates list above with a brief description.
It's up to you whether or not to rename your fork/own version. Do whatever you think sounds good.

Or Submit a Pull Request

I also accept pull requests on this, if they're small, atomic, and if they make my own packaging experience better.

cookiecutter-poetry's People

Contributors

Stargazers

Watchers

Forkers

mateuspontesm gantir adamwojt lachhebo elbakramer bvangrinsven paulsteffen-betclic threeel zpyoung francisco-ltech liam-stevens wookiesh axiak dcode bhoy-troy millsks

cookiecutter-poetry's Issues

No attribute needed to create .travis file

Describe the bug
The creation of the .travis file reads the attribute ''use_pypi_deployment_with_travis", that was removed in commit 'Remove use_pypi_deployments_with_travis prompt'.

To Reproduce
Steps to reproduce the behavior:

Just install and answer all questions.

Expected behavior
Clear creation with no errors.

Issues with tox

Describe the bug
tox.ini needs to be revised to work with poetry and the src/project:

To Reproduce
Steps to reproduce the behavior:

Install the template
Run poetry install
Run poetry shell
On poetry shell run: $ tox

Expected behavior
Run tests clearly.

Probable solution
add

[tox]
isolated_build = True

[testenv:flake8]
basepython = python3
deps = flake8
commands = flake8 src/{{ cookiecutter.module_name }}

The problem is the part:

deps =
    -r{toxinidir}/requirements_dev.txt

I had to export with poetry export -f requirements.txt --dev --without-hashes -o requirements_dev.txt, but I expect to have a simpler solution to read the pyproject.toml

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

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.

Add configurations for multiple CI tools

Add configurations for the following CI tools:

Travis
Github Actions
None

Get `version` and `release` from Poetry file in `docs/conf.py`

It currently still references __version__ in package/__init__.py, which doesn't exist any more.

Make sure Tox works with Poetry

A .tox file is included in the baked project, but it has not been tested yet.

Error message: 'collections.OrderedDict object' has no attribute 'use_pypi_deployment_with_travis'

Describe the bug

Trying to create a new package and the template crashes in the interactive creation.

To Reproduce

Run the command on my local.

Expected behavior

The command finishes without crashing.

Screenshots

The command crashes after Pycharm question

Unable to create file '.travis.yml'
Error message: 'collections.OrderedDict object' has no attribute 'use_pypi_deployment_with_travis'
Context: {
    "cookiecutter": {
        "_output_dir": "/Users/moo/code/ts",
        "_template": "https://github.com/johanvergeer/cookiecutter-poetry.git",
        "command_line_interface": "none",
        "create_author_file": "n",
        "create_docs": "y",
        "email": "[email protected]",
        "full_name": "Mikko Ohtamaa",
        "github_username": "miohtama",
        "module_name": "top",
        "open_source_license": "MIT license",
        "project_name": "Top Framework",
        "project_short_description": "Framwork for building UNIX top-like TUI applications easily",
        "project_slug": "top-framework",
        "pypi_username": "miohtama",
        "use_pycharm": "y",
        "version": "0.1.0"
    }
}

Desktop:

OS: macOS
Python 3.9

Add pre-commit configuration

Add a pre-commit configuration for the main project and the baked project

Please publish to pypi

this is an awesome repo, please publish to pypi with all relevant information wrt releases versions etc. so companies can pull into internal artifactory / package managers.

Enough said,

Ciao

Initial Update

The bot created this issue to inform you that pyup.io has been set up on this repo.
Once you have closed it, the bot will open pull requests for updates as soon as they are available.