-
Notifications
You must be signed in to change notification settings - Fork 1
/
PKG-INFO
179 lines (128 loc) · 7.55 KB
/
PKG-INFO
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
167
168
169
170
171
172
173
174
175
176
177
178
179
Metadata-Version: 1.0
Name: kotti-software
Version: 0.1.1
Summary: Add a software project listing to your Kotti site
Home-page: https://github.com/geojeff/kotti_software
Author: geojeff
Author-email: geojeff@me.com
License: BSD-derived (http://www.repoze.org/LICENSE.txt)
Description:
==============
kotti_software
==============
This is an extension to the Kotti CMS that adds a system for presenting
software projects on your site.
kotti_software started as a copy of kotti_blog.
`Find out more about Kotti`_
Setting up kotti_software
=========================
This Addon adds two new Content Types to your Kotti site.
To set up the content types add ``kotti_software.kotti_configure``
to the ``kotti.configurators`` setting in your ini file::
kotti.configurators = kotti_software.kotti_configure
Now you can create a software collection and add software projects.
There are different settings to adjust the behavior of the
software.
You can select if the software projects in the collection overview
should be batched. If you set
``kotti_software.collection_settings.use_batching`` to ``true``
(the default value) the software projects will be shown on separate
pages. If you set it to ``false`` all software projects are shown
all together on one page::
kotti_software.collection_settings.use_batching = false
If you use batching you can choose how many software projects are
shown on one page. The default value for
``kotti_software.collection_settings.pagesize`` is 5::
kotti_software.collection_settings.pagesize = 10
You can use auto batching where the next page of the software projects
is automatically loaded when scrolling down the overview page instead
of showing links to switch the pages. The default for
``kotti_software.collection_settings.use_auto_batching`` is ``true``::
kotti_software.collection_settings.use_auto_batching = false
With ``kotti_software.collection_settings.link_headline_overview`` you
can control whether the headline of a software project in the
collection overview is linked to the software project or not. This
setting defaults to ``true``::
kotti_software.collection_settings.link_headline_overview = false
Parts of kotti_software can be overridden with the setting
``kotti_software.asset_overrides``. Have a look to the
`Kotti documentation about the asset_overrides setting`_, which is the
same as in ``kotti_software``.
Be warned: This addon is in alpha state. Use it at your own risk.
Using kotti_software
====================
Add a software collection to your site, then to that add software projects.
For software projects, you can provide a date, which you will need to
manually keep up to date. Or, you can provide a json_url instead of a date
and the last-updated date for the project, along with main urls and a few
data items, will be gathered from a JSON source.
Here are ways to enter software projects:
1) Enter the JSON url only (for JSON-fetched date and data)
2) Enter the date and any of: home_page, docs_url,
package_url, bugtrack_url (manual entry)
3) Enter the date only (bare-bones entry, with just date and
title, and whatever is in body -- useful for defunct
projects)
There is a date-handling select list to set, accordingly, for 1), 2), or 3).
In a manner similar to date handling, you can enter a description, or you may
set the description from either the summary or description in the JSON data.
For the JSON data, if your project is a Python project and it has been posted
to pypi.python.org, you can enter the JSON url for that, as described below.
Otherwise, make your own JSON file, using the following format, and post it
somewhere, then enter that URL.
::
{
"info": {
"home_page": "http://kotti.pylonsproject.org",
"docs_url": "http://packages.python.org/Kotti",
"package_url": "http://pypi.python.org/pypi/Kotti",
"bugtrack_url": "",
"description": "Kotti is a high-level, 'Pythonic' framework...",
"summary": "Kotti is a high-level, 'Pythonic' framework..."
},
"urls": [ { "upload_time": "2012-08-30T11:59:58", } ]
}
Note that the home_page, docs_url, package_url, and bugtrack_url are key/value
pairs in "info", but the date is derived from "upload_time" in "urls". If the
data structure for upload_time looks unnecessarily complicated, it is this
way because we follow the pypi JSON structure. kotti_software is written, in
part, for use on the Kotti website, and thus presents Python projects that
are posted on pypi. Also, kotti_software is used by Kotti developers on their
personal websites, and they tend to have Python projects. However, any type of
project can be posted, for javascript, Ruby, etc. Just follow the data structure
format above for creating a custom JSON data structure for each project.
If you need to customize kotti_software itself, the urls are accessed as
json_obj['info']['docs_url'], and the upload_time is accessed as
json_obj['urls'][0]['upload_time'].
If the description is entered manually, it is used, but if left blank, and the
"summary" item in the JSON data is not empty, the summary is used as the
description.
**Instructions for JSON sources:**
pypi
----
Enter the url of the form "http://pypi.python.org/pypi/{project name}/json",
where {project name} is the case-sensitive name of the project on pypi. For
example, for Kotti the url is "http://pypi.python.org/pypi/Kotti/json".
See http://pypi.python.org/pypi/Kotti/json to see the JSON that is parsed.
Hosting Elsewhere
-----------------
As an alternative to pypi, if your project is not posted there, you may put
a JSON file somewhere in your github, bitbucket, or other repo, and access
it with the raw url, such as this example for github:
json_url = "https://raw.github.com/geojeff/kotti_fruits_example/master/json"
As described above, you will need to follow the format of the pypi JSON data.
.. _Find out more about Kotti: http://pypi.python.org/pypi/Kotti
.. _Kotti documentation about the asset_overrides setting: http://kotti.readthedocs.org/en/latest/configuration.html?highlight=asset#adjust-the-look-feel-kotti-asset-overrides
Authors
=======
Jeff Pittman [geojeff]
for kotti_blog:
Marco Scheidhuber [j23d]
Mike Orr [mikeorr]
CHANGES
=======
0.1
---
- Initial release.
Keywords: kotti software
Platform: UNKNOWN