-
Notifications
You must be signed in to change notification settings - Fork 2k
/
README.rst_tmpl
167 lines (108 loc) · 4.79 KB
/
README.rst_tmpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
.. You should enable this project on travis-ci.org and coveralls.io to make
these badges work. The necessary Travis and Coverage config files have been
generated for you.
.. image:: https://travis-ci.org/{{ github_user_name }}/{{ project }}.svg?branch=master
:target: https://travis-ci.org/{{ github_user_name }}/{{ project }}
.. image:: https://coveralls.io/repos/{{ github_user_name }}/{{ project }}/badge.svg
:target: https://coveralls.io/r/{{ github_user_name }}/{{ project }}
.. image:: https://pypip.in/download/{{ project }}/badge.svg
:target: https://pypi.python.org/pypi//{{ project }}/
:alt: Downloads
.. image:: https://pypip.in/version/{{ project }}/badge.svg
:target: https://pypi.python.org/pypi/{{ project }}/
:alt: Latest Version
.. image:: https://pypip.in/py_versions/{{ project }}/badge.svg
:target: https://pypi.python.org/pypi/{{ project }}/
:alt: Supported Python versions
.. image:: https://pypip.in/status/{{ project }}/badge.svg
:target: https://pypi.python.org/pypi/{{ project }}/
:alt: Development Status
.. image:: https://pypip.in/license/{{ project }}/badge.svg
:target: https://pypi.python.org/pypi/{{ project }}/
:alt: License
=============
{{ project }}
=============
.. Put a description of your extension here:
What does it do? What features does it have?
Consider including some screenshots or embedding a video!
------------
Requirements
------------
For example, you might want to mention here which versions of CKAN this
extension works with.
------------
Installation
------------
.. Add any additional install steps to the list below.
For example installing any non-Python dependencies or adding any required
config settings.
To install {{ project }}:
1. Activate your CKAN virtual environment, for example::
. /usr/lib/ckan/default/bin/activate
2. Install the {{ project }} Python package into your virtual environment::
pip install {{ project }}
3. Add ``{{ project_shortname }}`` to the ``ckan.plugins`` setting in your CKAN
config file (by default the config file is located at
``/etc/ckan/default/production.ini``).
4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
sudo service apache2 reload
---------------
Config Settings
---------------
Document any optional config settings here. For example::
# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.{{ project_shortname }}.some_setting = some_default_value
------------------------
Development Installation
------------------------
To install {{ project }} for development, activate your CKAN virtualenv and
do::
git clone https://github.com/{{ github_user_name }}/{{ project }}.git
cd {{ project }}
python setup.py develop
pip install -r dev-requirements.txt
-----------------
Running the Tests
-----------------
To run the tests, do::
nosetests --nologcapture --with-pylons=test.ini
To run the tests and produce a coverage report, first make sure you have
coverage installed in your virtualenv (``pip install coverage``) then run::
nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.{{ project_shortname }} --cover-inclusive --cover-erase --cover-tests
---------------------------------
Registering {{ project }} on PyPI
---------------------------------
{{ project }} should be availabe on PyPI as
https://pypi.python.org/pypi/{{ project }}. If that link doesn't work, then
you can register the project on PyPI for the first time by following these
steps:
1. Create a source distribution of the project::
python setup.py sdist
2. Register the project::
python setup.py register
3. Upload the source distribution to PyPI::
python setup.py sdist upload
4. Tag the first release of the project on GitHub with the version number from
the ``setup.py`` file. For example if the version number in ``setup.py`` is
0.0.1 then do::
git tag 0.0.1
git push --tags
----------------------------------------
Releasing a New Version of {{ project }}
----------------------------------------
{{ project }} is availabe on PyPI as https://pypi.python.org/pypi/{{ project }}.
To publish a new version to PyPI follow these steps:
1. Update the version number in the ``setup.py`` file.
See `PEP 440 <http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers>`_
for how to choose version numbers.
2. Create a source distribution of the new version::
python setup.py sdist
3. Upload the source distribution to PyPI::
python setup.py sdist upload
4. Tag the new release of the project on GitHub with the version number from
the ``setup.py`` file. For example if the version number in ``setup.py`` is
0.0.2 then do::
git tag 0.0.2
git push --tags