This is a project that keeps its code under a src/ subfolder:
nameis given explicitly insetup.py- module + submodule in
src/hierarchical/->packagesis properly set to['hierarchical', 'hierarchical.submodule'] version,keywords, etc comes fromsrc/hierarchical/__init__.py(download_urlmentions{version})- an
entry_points.inifile is used to specify some entry points - a
README.rstfile partially used aslong_description
This part will be ignored for setup.py long_description, due to [[end long_description]] hidden token above (see source of this README, line 15)
project layout is:
|-- LICENSE.txt |-- README.rst |-- entry_points.ini |-- requirements.txt |-- setup.py |-- src/ |-- hierarchical/ # Python module under src/ |-- __init__.py # Definitions are taken from here |-- submodule/ # Submodule shows up in 'packages' |-- __init__.pysetup.pycontents:from setuptools import setup setup( name="hierarchical", setup_requires=['setupmeta'] )src/hierarchical/__init__.pycontents:""" A hierarchical package (code under src/, tests under tests/) keywords: hierarchical, package author: Someone [email protected] """ __version__ = '1.0.0' __url__ = "https://github.com/codrsquad" __download_url__ = "archive/{version}.tar.gz" def main(): pass
explainoutput:author: (auto-adjust ) Someone \_: (src/hierarchical/__init__.py:5 ) Someone [email protected] author_email: (auto-adjust ) [email protected] bugtrack_url: (auto-fill ) https://github.com/codrsquad/hierarchical/issues description: (README.rst:1 ) A hierarchical package (code under src/) \_: (src/hierarchical/__init__.py:2 ) A hierarchical package (code under src/, tests under tests/) download_url: (auto-fill ) https://github.com/codrsquad/hierarchical/archive/1.0.0.tar.gz \_: (src/hierarchical/__init__.py:10) archive/{version}.tar.gz entry_points: (entry_points.ini ) [console_scripts] hierarchical = hierarchical:main subm = hierarchical.submodule:main install_requires: (requirements.txt ) ['click>=6.7', 'pytest-cov'] keywords: (src/hierarchical/__init__.py:4 ) ['hierarchical', 'package'] license: (auto-fill ) MIT long_description: (README.rst ) 616 chars: hierarchical: A hierarchical package (code under src/) ... name: (setup.py:4 ) hierarchical package_dir: (auto-fill ) {: src} packages: (auto-fill ) ['hierarchical', 'hierarchical.submodule'] setup_requires: (explicit ) ['setupmeta'] url: (auto-fill ) https://github.com/codrsquad/hierarchical \_: (src/hierarchical/__init__.py:9 ) https://github.com/codrsquad version: (src/hierarchical/__init__.py:8 ) 1.0.0