Project

General

Profile

Download (4.89 KB) Statistics
| Branch: | Tag: | Revision:

theme / README.rst @ 738fde9b

1
.. You should enable this project on travis-ci.org and coveralls.io to make
2
   these badges work. The necessary Travis and Coverage config files have been
3
   generated for you.
4

    
5
.. image:: https://travis-ci.org//ckanext-ozwillo_theme.svg?branch=master
6
    :target: https://travis-ci.org//ckanext-ozwillo_theme
7

    
8
.. image:: https://coveralls.io/repos//ckanext-ozwillo_theme/badge.png?branch=master
9
  :target: https://coveralls.io/r//ckanext-ozwillo_theme?branch=master
10

    
11
.. image:: https://pypip.in/download/ckanext-ozwillo_theme/badge.svg
12
    :target: https://pypi.python.org/pypi//ckanext-ozwillo_theme/
13
    :alt: Downloads
14

    
15
.. image:: https://pypip.in/version/ckanext-ozwillo_theme/badge.svg
16
    :target: https://pypi.python.org/pypi/ckanext-ozwillo_theme/
17
    :alt: Latest Version
18

    
19
.. image:: https://pypip.in/py_versions/ckanext-ozwillo_theme/badge.svg
20
    :target: https://pypi.python.org/pypi/ckanext-ozwillo_theme/
21
    :alt: Supported Python versions
22

    
23
.. image:: https://pypip.in/status/ckanext-ozwillo_theme/badge.svg
24
    :target: https://pypi.python.org/pypi/ckanext-ozwillo_theme/
25
    :alt: Development Status
26

    
27
.. image:: https://pypip.in/license/ckanext-ozwillo_theme/badge.svg
28
    :target: https://pypi.python.org/pypi/ckanext-ozwillo_theme/
29
    :alt: License
30

    
31
=============
32
ckanext-ozwillo_theme
33
=============
34

    
35
.. Put a description of your extension here:
36
   What does it do? What features does it have?
37
   Consider including some screenshots or embedding a video!
38

    
39

    
40
------------
41
Requirements
42
------------
43

    
44
For example, you might want to mention here which versions of CKAN this
45
extension works with.
46

    
47

    
48
------------
49
Installation
50
------------
51

    
52
.. Add any additional install steps to the list below.
53
   For example installing any non-Python dependencies or adding any required
54
   config settings.
55

    
56
To install ckanext-ozwillo_theme:
57

    
58
1. Activate your CKAN virtual environment, for example::
59

    
60
     . /usr/lib/ckan/default/bin/activate
61

    
62
2. Install the ckanext-ozwillo_theme Python package into your virtual environment::
63

    
64
     pip install ckanext-ozwillo_theme
65

    
66
3. Add ``ozwillo_theme`` to the ``ckan.plugins`` setting in your CKAN
67
   config file (by default the config file is located at
68
   ``/etc/ckan/default/production.ini``).
69

    
70
4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
71

    
72
     sudo service apache2 reload
73

    
74

    
75
---------------
76
Config Settings
77
---------------
78

    
79
Document any optional config settings here. For example::
80

    
81
    # The minimum number of hours to wait before re-checking a resource
82
    # (optional, default: 24).
83
    ckanext.ozwillo_theme.some_setting = some_default_value
84

    
85

    
86
------------------------
87
Development Installation
88
------------------------
89

    
90
To install ckanext-ozwillo_theme for development, activate your CKAN virtualenv and
91
do::
92

    
93
    git clone https://github.com//ckanext-ozwillo_theme.git
94
    cd ckanext-ozwillo_theme
95
    python setup.py develop
96
    pip install -r dev-requirements.txt
97

    
98

    
99
-----------------
100
Running the Tests
101
-----------------
102

    
103
To run the tests, do::
104

    
105
    nosetests --nologcapture --with-pylons=test.ini
106

    
107
To run the tests and produce a coverage report, first make sure you have
108
coverage installed in your virtualenv (``pip install coverage``) then run::
109

    
110
    nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.ozwillo_theme --cover-inclusive --cover-erase --cover-tests
111

    
112

    
113
---------------------------------
114
Registering ckanext-ozwillo_theme on PyPI
115
---------------------------------
116

    
117
ckanext-ozwillo_theme should be availabe on PyPI as
118
https://pypi.python.org/pypi/ckanext-ozwillo_theme. If that link doesn't work, then
119
you can register the project on PyPI for the first time by following these
120
steps:
121

    
122
1. Create a source distribution of the project::
123

    
124
     python setup.py sdist
125

    
126
2. Register the project::
127

    
128
     python setup.py register
129

    
130
3. Upload the source distribution to PyPI::
131

    
132
     python setup.py sdist upload
133

    
134
4. Tag the first release of the project on GitHub with the version number from
135
   the ``setup.py`` file. For example if the version number in ``setup.py`` is
136
   0.0.1 then do::
137

    
138
       git tag 0.0.1
139
       git push --tags
140

    
141

    
142
----------------------------------------
143
Releasing a New Version of ckanext-ozwillo_theme
144
----------------------------------------
145

    
146
ckanext-ozwillo_theme is availabe on PyPI as https://pypi.python.org/pypi/ckanext-ozwillo_theme.
147
To publish a new version to PyPI follow these steps:
148

    
149
1. Update the version number in the ``setup.py`` file.
150
   See `PEP 440 <http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers>`_
151
   for how to choose version numbers.
152

    
153
2. Create a source distribution of the new version::
154

    
155
     python setup.py sdist
156

    
157
3. Upload the source distribution to PyPI::
158

    
159
     python setup.py sdist upload
160

    
161
4. Tag the new release of the project on GitHub with the version number from
162
   the ``setup.py`` file. For example if the version number in ``setup.py`` is
163
   0.0.2 then do::
164

    
165
       git tag 0.0.2
166
       git push --tags
(4-4/10)