You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: {{cookiecutter.project_slug}}/README.rst
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,12 +34,12 @@ This repository is set up with Python versions: 2.7, 3.4, 3.5, and 3.6. Add or r
34
34
Package management
35
35
------------------
36
36
37
-
You can use either `pip` or `conda` for installing dependencies and package management. This repository does not force you to use one or the other, as project requirements differ. For advice on what to use, please check `the relevant section of the guide <https://guide.esciencecenter.nl/languages/python.html#dependencies-and-package-management>`_.
37
+
You can use either `pip` or `conda` for installing dependencies and package management. This repository does not force you to use one or the other, as project requirements differ. For advice on what to use, please check `the relevant section of the guide <https://guide.esciencecenter.nl/best_practices/language_guides/python.html#dependencies-and-package-management>`_.
38
38
39
39
Packaging/One command install
40
40
-----------------------------
41
41
42
-
You can distribute your code using pipy or conda. Again, the project template does not enforce the use of either one. `The guide <https://guide.esciencecenter.nl/languages/python.html#building-and-packaging-code>`_ can help you decide which tool to use for packaging.
42
+
You can distribute your code using pipy or conda. Again, the project template does not enforce the use of either one. `The guide <https://guide.esciencecenter.nl/best_practices/language_guides/python.html#building-and-packaging-code>`_ can help you decide which tool to use for packaging.
43
43
44
44
Testing and code coverage
45
45
-------------------------
@@ -59,6 +59,7 @@ Testing and code coverage
59
59
- `Getting started with Travis CI <https://docs.travis-ci.com/user/getting-started/>`_
60
60
61
61
* TODO: add something about code quality/coverage tool?
62
+
* `Relevant section in the guide <https://guide.esciencecenter.nl/best_practices/language_guides/python.html#testing>`_
62
63
63
64
Documentation
64
65
-------------
@@ -79,13 +80,15 @@ Documentation
79
80
80
81
- Include the link to the documentation in this README_.
81
82
83
+
* `Relevant section in the guide <https://guide.esciencecenter.nl/best_practices/language_guides/python.html#writingdocumentation>`_
84
+
82
85
Coding style conventions and code quality
83
86
-----------------------------------------
84
87
85
88
* Check your code style with ``prospector``
86
89
* You may need run ``pip install .[dev]`` first, to install the required dependencies
87
90
* You can use ``yapf`` to fix the readability of your code style and ``isort`` to format and group your imports
88
-
* `Relevant section in the guide <https://guide.esciencecenter.nl/languages/python.html#coding-style-conventions>`_
91
+
* `Relevant section in the guide <https://guide.esciencecenter.nl/best_practices/language_guides/python.html#coding-style-conventions>`_
89
92
90
93
CHANGELOG.rst
91
94
------------
@@ -117,13 +120,13 @@ MANIFEST.in
117
120
-----------
118
121
119
122
* List non-Python files that should be included in a source distribution
120
-
* `Relevant section in the guide <https://guide.esciencecenter.nl/languages/python.html#building-and-packaging-code>`_
123
+
* `Relevant section in the guide <https://guide.esciencecenter.nl/best_practices/language_guides/python.html#building-and-packaging-code>`_
121
124
122
125
NOTICE
123
126
------
124
127
125
128
* List of licenses of the project and dependencies
126
-
* `Relevant section in the guide <https://guide.esciencecenter.nl/software/licensing.html#noticetxtmd>`_
129
+
* `Relevant section in the guide <https://guide.esciencecenter.nl/best_practices/licensing.html#notice>`_
0 commit comments