Project

General

Profile

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

theme / README.rst @ 14fbb44a

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
The configuration variable ``ckanext.ozwillo_theme.plugin.ozwillo_url`` must be
48
set(for example to https://ozwillo-preprod.eu)
49

    
50

    
51
------------
52
Installation
53
------------
54

    
55
.. Add any additional install steps to the list below.
56
   For example installing any non-Python dependencies or adding any required
57
   config settings.
58

    
59
To install ckanext-ozwillo_theme:
60

    
61
1. Activate your CKAN virtual environment, for example::
62

    
63
     . /usr/lib/ckan/default/bin/activate
64

    
65
2. Install the ckanext-ozwillo_theme Python package into your virtual environment::
66

    
67
     pip install ckanext-ozwillo_theme
68

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

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

    
75
     sudo service apache2 reload
76

    
77

    
78
---------------
79
Config Settings
80
---------------
81

    
82
Document any optional config settings here. For example::
83

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

    
88

    
89
------------------------
90
Development Installation
91
------------------------
92

    
93
To install ckanext-ozwillo_theme for development, activate your CKAN virtualenv and
94
do::
95

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

    
101

    
102
-----------------
103
Running the Tests
104
-----------------
105

    
106
To run the tests, do::
107

    
108
    nosetests --nologcapture --with-pylons=test.ini
109

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

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

    
115

    
116
---------------------------------
117
Registering ckanext-ozwillo_theme on PyPI
118
---------------------------------
119

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

    
125
1. Create a source distribution of the project::
126

    
127
     python setup.py sdist
128

    
129
2. Register the project::
130

    
131
     python setup.py register
132

    
133
3. Upload the source distribution to PyPI::
134

    
135
     python setup.py sdist upload
136

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

    
141
       git tag 0.0.1
142
       git push --tags
143

    
144

    
145
----------------------------------------
146
Releasing a New Version of ckanext-ozwillo_theme
147
----------------------------------------
148

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

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

    
156
2. Create a source distribution of the new version::
157

    
158
     python setup.py sdist
159

    
160
3. Upload the source distribution to PyPI::
161

    
162
     python setup.py sdist upload
163

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

    
168
       git tag 0.0.2
169
       git push --tags
(4-4/10)