kotti_software 0.1.4

Kotti software -- adds a software project listing to your site

This is an extension to the Kotti CMS that adds a system for presenting a list of software projects on your site.

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. Here are ways to enter software projects:

1. Enter the PyPI JSON URL only

2. Enter the PyPI JSON URL, along with the GitHub repo info for fetching the GitHub repo information, such as most recent push date and time, or do the same for a Bitbucket repo (You could do both, for a project with both GitHub and Bitbucket repos.

3. Enter only the GitHub repo info, or the Bitbucket info, for a repo-only software project.

4. Enter the title, description, date and any of: home_page, docs_url, package_url, bugtrack_url (manual entry), and specify that these values are not to be overwritten from values on PyPI, if they exist.

5. Enter the date only (bare-bones entry, with just date and title, description, and whatever you wish in body – useful for defunct projects). Set the date-handling choice to use the entered value.

The date-handling and description-handling select properties should be set according to the usage above, and whether the entered values are to be used, or if values are to be fetched from PyPI or GitHub or Bitbucket.

There are also boolean override properties for using a combination of manually entered values for home_page, docs_url, package_url, and bugtrack_url and the fetching of these values from PyPI.

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.

GitHub

Enter the GitHub owner and repo, which will be used to build a GitHub API call of the form: https://api.github.com/repos/{owner}/{repo}, as in https://api.github.com/repos/geojeff/kotti_software. You may enter this GitHub info along with the PyPI URL, or use the GitHub info only.

Bitbucket

Enter the Bitbucket owner and repo, which will be used to build a Bitbucket API call of the form: https://api.bitbucket.org/repostories/{owner}/{repo}.

Work in progress

kotti_software is considered alpha software, not yet suitable for use in production environments. The current state of the project is in no way feature complete nor API stable. If you really want to use it in your project(s), make sure to pin the exact version in your requirements. Not doing so will likely break your project when future releases become available.

Development

Contributions to kotti_software are very welcome. Just clone its GitHub repository and submit your contributions as pull requests.

Note that all development is done on the develop branch. master is reserved for “production-ready state”. Therefore, make sure to always base development work on the current state of the develop branch.

This follows the highly recommended A successful Git branching model pattern, which is implemented by the excellent gitflow git extension.

Testing

kotti_software has 100% test coverage. Please make sure that you add tests for new features and that all tests pass before submitting pull requests. Running the test suite is as easy as running py.test from the source directory (you might need to run python setup.py dev to have all the test requirements installed in your virtualenv).

TODO

• Add i18n

• Add navpill-style and table-style list views for projects; make list style selectable in edit menu [Can/should this be punted to Kotti folder view?]

• Sort out and document metadata items available in setup.py vs. those requiring manual entry on pypi or in kotti_software. See what happens when bugtrack_url, home_page, and download_url are added to setup.py. What is download_url vs. package_url? Does url in setup.py map to home_page? [Home page, Download URL, and Bugtrack URL are editable on pypi. If they are not available in setup.py, then if set manually on pypi, are they overwritten by new release pushes to pypi, or do they stick?]

• Check on need for required testing dependencies copied from kotti_media

• Add support for using tags to categorize by group with an example, or add a “sub-collection” property if the tags route is not workable.

• Presently, the view for SoftwareCollection does a site-wide search for all SoftwareProject items. Should this be changed to context.children? [Ties in with tags and/or categorization question.]

• Change use of all-jambed-up softwarecollection to software-collection and software_collection; same for softwareproject. Or, OK as is?

• Add better visual separation between items in default list view (the only list view style available now; see above todo item)

• Are on-load refreshes from pypi and github too expensive? What are alternatives? Nightly cron job? More frequent cron job? Refreshing on a timer? Every 5 minutes? Every hour? Manual trigger by admin?

Authors

Jeff Pittman [geojeff]

kotti_software started as a copy of kotti_blog, and also follows some design and layout features of kotti_media.

for kotti_media:

Andreas Kaiser [disko]

for kotti_blog:

Marco Scheidhuber [j23d] Mike Orr [mikeorr]

CHANGES

0.1.4

• Updated readme for revised usage instructions.

0.1.3

• Renamed user to owner for github and bitbucket.

• In property descriptions, now using PyPI, GitHub, and Bitbucket spellings.

• Added bitbucket as JSON source.

• Removed generic JSON source option, and made all references explicit for PyPI.

0.1.2

• Added support for sorting in either ascending or descending order (default is still descending).

• Added github repo API call as an alternate or sole JSON source.

• Cleaned up sorting code.

0.1.1

• Added missing TODO.txt.

• Changed test urls to hit pypi/Kotti/json.

• Prepared MANIFEST.in.

• Updated README following pattern of kotti_media.

0.1

• Initial release.

• Started with copy of kotti_blog.

• During development referred to kotti_media for adding url properties, for setting up view classes, and for preparation of tests and use of travis-ci.org.