https://github.com/datopian/ckanext-panamatheme
https://github.com/datopian/ckanext-panamatheme
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/datopian/ckanext-panamatheme
- Owner: datopian
- License: agpl-3.0
- Created: 2016-04-20T22:23:50.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-20T23:57:45.000Z (almost 10 years ago)
- Last Synced: 2025-07-02T11:13:43.046Z (8 months ago)
- Language: HTML
- Size: 2.81 MB
- Stars: 4
- Watchers: 19
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. 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/dumyan/ckanext-panamatheme.svg?branch=master
:target: https://travis-ci.org/dumyan/ckanext-panamatheme
.. image:: https://coveralls.io/repos/dumyan/ckanext-panamatheme/badge.svg
:target: https://coveralls.io/r/dumyan/ckanext-panamatheme
.. image:: https://pypip.in/download/ckanext-panamatheme/badge.svg
:target: https://pypi.python.org/pypi//ckanext-panamatheme/
:alt: Downloads
.. image:: https://pypip.in/version/ckanext-panamatheme/badge.svg
:target: https://pypi.python.org/pypi/ckanext-panamatheme/
:alt: Latest Version
.. image:: https://pypip.in/py_versions/ckanext-panamatheme/badge.svg
:target: https://pypi.python.org/pypi/ckanext-panamatheme/
:alt: Supported Python versions
.. image:: https://pypip.in/status/ckanext-panamatheme/badge.svg
:target: https://pypi.python.org/pypi/ckanext-panamatheme/
:alt: Development Status
.. image:: https://pypip.in/license/ckanext-panamatheme/badge.svg
:target: https://pypi.python.org/pypi/ckanext-panamatheme/
:alt: License
=============
ckanext-panamatheme
=============
.. 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 ckanext-panamatheme:
1. Activate your CKAN virtual environment, for example::
. /usr/lib/ckan/default/bin/activate
2. Install the ckanext-panamatheme Python package into your virtual environment::
pip install ckanext-panamatheme
3. Add ``panamatheme`` 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.panamatheme.some_setting = some_default_value
------------------------
Development Installation
------------------------
To install ckanext-panamatheme for development, activate your CKAN virtualenv and
do::
git clone https://github.com/dumyan/ckanext-panamatheme.git
cd ckanext-panamatheme
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.panamatheme --cover-inclusive --cover-erase --cover-tests
---------------------------------
Registering ckanext-panamatheme on PyPI
---------------------------------
ckanext-panamatheme should be availabe on PyPI as
https://pypi.python.org/pypi/ckanext-panamatheme. 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 ckanext-panamatheme
----------------------------------------
ckanext-panamatheme is availabe on PyPI as https://pypi.python.org/pypi/ckanext-panamatheme.
To publish a new version to PyPI follow these steps:
1. Update the version number in the ``setup.py`` file.
See `PEP 440 `_
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