changeset b0547a81a2ea in cookiecutter:default
details: https://hg.tryton.org/cookiecutter?cmd=changeset;node=b0547a81a2ea
description:
Merge README and doc and remove INSTALL
issue7397
review271241002
diffstat:
hooks/post_gen_project.py | 5 ++++
{{ cookiecutter.module_name }}/INSTALL | 29 -------------------------
{{ cookiecutter.module_name }}/MANIFEST.in | 5 +--
{{ cookiecutter.module_name }}/README | 34 ------------------------------
{{ cookiecutter.module_name }}/setup.py | 10 +++++++-
5 files changed, 15 insertions(+), 68 deletions(-)
diffs (124 lines):
diff -r ae36de7c6dfc -r b0547a81a2ea hooks/post_gen_project.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/hooks/post_gen_project.py Sat Apr 06 17:39:37 2019 +0200
@@ -0,0 +1,5 @@
+import os
+try:
+ os.symlink('doc/index.rst', 'README.rst')
+except AttributeError:
+ pass
diff -r ae36de7c6dfc -r b0547a81a2ea {{ cookiecutter.module_name }}/INSTALL
--- a/{{ cookiecutter.module_name }}/INSTALL Sun Mar 31 00:13:59 2019 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,29 +0,0 @@
-Installing {{ cookiecutter.package_name }}
-{{ '=' * (cookiecutter.package_name|length + 11) }}
-
-Prerequisites
--------------
-
- * Python 3.4 or later (http://www.python.org/)
- * trytond (http://www.tryton.org/)
-
-Installation
-------------
-
-Once you've downloaded and unpacked the {{ cookiecutter.package_name }} source
-release, enter the directory where the archive was unpacked, and run:
-
- python setup.py install
-
-Note that you may need administrator/root privileges for this step, as
-this command will by default attempt to install module to the Python
-site-packages directory on your system.
-
-For advanced options, please refer to the easy_install and/or the distutils
-documentation:
-
- http://setuptools.readthedocs.io/en/latest/easy_install.html
- http://docs.python.org/inst/inst.html
-
-To use without installation, extract the archive into ``trytond/modules`` with
-the directory name {{ cookiecutter.module_name }}.
diff -r ae36de7c6dfc -r b0547a81a2ea {{ cookiecutter.module_name }}/MANIFEST.in
--- a/{{ cookiecutter.module_name }}/MANIFEST.in Sun Mar 31 00:13:59
2019 +0100
+++ b/{{ cookiecutter.module_name }}/MANIFEST.in Sat Apr 06 17:39:37
2019 +0200
@@ -1,6 +1,5 @@
-include INSTALL
-include README
+include CHANGELOG
include COPYRIGHT
-include CHANGELOG
include LICENSE
+include README.rst
include doc/*
diff -r ae36de7c6dfc -r b0547a81a2ea {{ cookiecutter.module_name }}/README
--- a/{{ cookiecutter.module_name }}/README Sun Mar 31 00:13:59 2019 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,34 +0,0 @@
-{{ cookiecutter.package_name }}
-{{ '=' * cookiecutter.package_name|length }}
-
-The {{ cookiecutter.module_name }} module of the Tryton application platform.
-
-Installing
-----------
-
-See INSTALL
-{% if not cookiecutter.prefix %}
-Support
--------
-
-If you encounter any problems with Tryton, please don't hesitate to ask
-questions on the Tryton forum or IRC channel:
-
- http://www.tryton.org/forum
-{% endif %}
-License
--------
-
-See LICENSE
-
-Copyright
----------
-
-See COPYRIGHT
-{%- if not cookiecutter.prefix %}
-
-
-For more information please visit the Tryton web site:
-
- http://www.tryton.org/
-{%- endif %}
diff -r ae36de7c6dfc -r b0547a81a2ea {{ cookiecutter.module_name }}/setup.py
--- a/{{ cookiecutter.module_name }}/setup.py Sun Mar 31 00:13:59 2019 +0100
+++ b/{{ cookiecutter.module_name }}/setup.py Sat Apr 06 17:39:37 2019 +0200
@@ -32,7 +32,7 @@
config = ConfigParser()
-config.read_file(open('tryton.cfg'))
+config.read_file(open(os.path.join(os.path.dirname(__file__), 'tryton.cfg')))
info = dict(config.items('tryton'))
for key in ('depends', 'extras_depend', 'xml'):
if key in info:
@@ -74,12 +74,18 @@
setup(name=name,
version=version,
description='{{ cookiecutter.description }}',
- long_description=read('README'),
+ long_description=read('README.rst'),
author='{{ cookiecutter.author }}',
author_email='{{ cookiecutter.author_email }}',
url='{{ cookiecutter.url }}',
{%- if not cookiecutter.prefix %}
download_url=download_url,
+ project_urls={
+ "Bug Tracker": 'https://bugs.tryton.org/',
+ "Documentation": 'https://docs.tryton.org/',
+ "Forum": 'https://www.tryton.org/forum',
+ "Source Code": 'https://hg.tryton.org/modules/{{
cookiecutter.module_name }}',
+ },
{%- endif %}
keywords='{{ cookiecutter.keywords }}',
package_dir={'trytond.modules.{{ cookiecutter.module_name }}': '.'},
