@@ -5,8 +5,8 @@ Python Project Template. INSERT TAGLINE HERE.™
5
5
:Author: Chris Warrick <chris@chriswarrick.com>
6
6
:Copyright: © 2013-2015, Chris Warrick.
7
7
:License: BSD (see /LICENSE or :doc: `Appendix B <LICENSE >`.)
8
- :Date: 2015-06-29
9
- :Version: 1.1 .1
8
+ :Date: 2015-06-30
9
+ :Version: 1.2 .1
10
10
11
11
.. index: README
12
12
.. image :: https://travis-ci.org/Kwpolska/python-project-template.png?branch=master
@@ -48,7 +48,8 @@ The template contains the following files to get you started:
48
48
script
49
49
* ``__init__.py `` and ``template.py `` files in the Python package directory
50
50
* A good-enough ``setup.py `` file
51
- * ``tests.py `` containing some *Is My Python Sane? *-style tests
51
+ * ``tests/ `` containing some *Is My Python Sane? *-style tests (using ``py.test ``)
52
+ * An automated global update script (``.pypt/PYPT-UPDATE ``)
52
53
* Entry points configuration ready to be uncommented
53
54
* Addons for Qt users
54
55
* PKGBUILDs for the Arch Linux User Repository (AUR)
@@ -63,7 +64,7 @@ The template contains the following files to get you started:
63
64
* committing into git, finishing the ``git flow `` release
64
65
* creating a GitHub Releases entry
65
66
66
- Getting up to speed in 15 easy steps
67
+ Getting up to speed in 16 easy steps
67
68
====================================
68
69
69
70
1. Create the repository for the project on GitHub and enable it on Travis CI.
@@ -99,8 +100,8 @@ Getting up to speed in 15 easy steps
99
100
1. ``/docs/README.rst `` to ``/README.rst `` and ``/README ``
100
101
2. ``/docs/CHANGELOG.rst `` to ``/CHANGELOG.rst ``
101
102
102
- 7. Modify ``/.pypt/config ``
103
- 8. Generate a `GitHub Personal Access Token <https://github.com/settings/tokens >`_ and write it to a ``/.pypt/gh-token `` file
103
+ 7. Modify ``/.pypt/config ``.
104
+ 8. Generate a `GitHub Personal Access Token <https://github.com/settings/tokens >`_ and write it to a ``/.pypt/gh-token `` file.
104
105
9. Customize ``/setup.py `` to your liking. You should pay attention to the
105
106
classifiers and the commented parts.
106
107
10. Customize ``requirements.txt ``.
@@ -123,8 +124,11 @@ Getting up to speed in 15 easy steps
123
124
PS. GNU GPL is not a good idea. You can use it, but the world would be
124
125
much happier if you did not.
125
126
126
- 15. Remove ``/.git ``, and run the following commands::
127
+ 15. If you have a ``PYPT-UPDATE `` script, add your new project to the list
128
+ there. If not, you may want to copy it from ``.pypt `` and set it up.
129
+ 16. Run the following commands::
127
130
131
+ rm -rf .git .pypt/PYPT-UPDATE
128
132
source .pypt/config
129
133
git init
130
134
git remote add origin git@github.com:$GITUSER/$GITREPO
@@ -148,7 +152,8 @@ commercial (a.k.a. proprietary) license, you must contact me first.
148
152
* /.pypt/commitlog
149
153
* /.pypt/ghrel
150
154
* /.pypt/localegen
151
- * /.pypt/README.PyPT
155
+ * /.pypt/PYPT-UPDATE
156
+ * /.pypt/README.rst
152
157
* /.pypt/LICENSE.PyPT
153
158
* /docs/CONTRIBUTING.rst
154
159
* /CONTRIBUTING.rst
0 commit comments