Skip to content

Best-practice for package version.py and setup.py #70

@manodeep

Description

@manodeep

First of all, thanks for creating the package. I have attempted to follow the instructions to use this package as the template for my own project.

I had a couple of questions about the setup.py:

  • Is there any way to avoid the exec on the text read in from version.py?
  • Related, would it be better practice to move the package info into setup.py (or setup.cfg) and then auto-generate the version.py (something like what numpy does)

I have a suggestion as well regarding the mis-match in the choice of documentation markup format. README.md is using markdown , however, the LONG_DESCRIPTION within shablona/version.py is using reStructuredText. Presumably, this is because PyPI does not play well with markdown, but the mis-match can be avoided by simply changing the md formats to rst. One advantage would then be that long_description be populated directly with the contents of the README.rst file during setup/upload

I apologize in advance if I have missed any steps or mis-understood the intent of the package template. Thanks again for creating this template.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions