Project

General

Profile

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

theme / README.rst @ cb0e91e4

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

    
53
------------
54
Installation
55
------------
56

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

    
61
To install ckanext-ozwillo_theme:
62

    
63
1. Activate your CKAN virtual environment, for example::
64

    
65
     . /usr/lib/ckan/default/bin/activate
66

    
67
2. Install the ckanext-ozwillo_theme Python package into your virtual environment::
68

    
69
     pip install ckanext-ozwillo_theme
70

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

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

    
77
     sudo service apache2 reload
78

    
79

    
80
---------------
81
Config Settings
82
---------------
83

    
84
Document any optional config settings here. For example::
85

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

    
90

    
91
------------------------
92
Development Installation
93
------------------------
94

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

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

    
103

    
104
-----------------
105
Running the Tests
106
-----------------
107

    
108
To run the tests, do::
109

    
110
    nosetests --nologcapture --with-pylons=test.ini
111

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

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

    
117

    
118
---------------------------------
119
Registering ckanext-ozwillo_theme on PyPI
120
---------------------------------
121

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

    
127
1. Create a source distribution of the project::
128

    
129
     python setup.py sdist
130

    
131
2. Register the project::
132

    
133
     python setup.py register
134

    
135
3. Upload the source distribution to PyPI::
136

    
137
     python setup.py sdist upload
138

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

    
143
       git tag 0.0.1
144
       git push --tags
145

    
146

    
147
----------------------------------------
148
Releasing a New Version of ckanext-ozwillo_theme
149
----------------------------------------
150

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

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

    
158
2. Create a source distribution of the new version::
159

    
160
     python setup.py sdist
161

    
162
3. Upload the source distribution to PyPI::
163

    
164
     python setup.py sdist upload
165

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

    
170
       git tag 0.0.2
171
       git push --tags
(4-4/10)