Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A tool to check for updates on web pages
Python

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
cupage
doc
.gitignore
COPYING
NEWS.rst
README.rst
cupage.py
setup.cfg
setup.py

README.rst

CUPage - Check for Updated Pages

Introduction

cupage is a tool to check for updates on web pages.

Requirements

cupage's mandatory dependencies outside of the standard library are:

It should run with Python 2.6 or newer [1]. If cupage doesn't work with the version of Python you have installed, drop me a mail and I'll endeavour to fix it.

The modules have been tested on many UNIX-like systems, including Linux, Solaris and OS X, but it should work fine on other systems too. The modules and scripts contain a large collection of doctest tests that can be checked with ./setup.py test_code, and the code examples in the documentation can be tested with ./setup.py test_doc.

[1]If you still run older versions only small changes are required, for example to the base class definitions and the unrolling of conditional expressions with python 2.4 or below. And for 2.5 only str.format usage and the json import should need changing.

Example

The simplest way to show how cupage works is by example. The following is an example configuration file:

# dev-python
[pep8]
site = pypi
match_type = tar
[pydelicious]
site = google code
match_type = zip
[pyisbn]
url = http://www.jnrowe.ukfsn.org/_downloads/
select = pre > a
match_type = tar
frequency = 6m
[upoints]
url = http://www.jnrowe.ukfsn.org/_downloads/
select = pre > a
match_type = tar
[fruity]
site = vim-script
script = 1871
[cupage]
site = github
user = JNRowe
frequency = 1m

API Stability

API stability isn't guaranteed across versions, although frivolous changes won't be made.

When cupage 1.0 is released the library API will be frozen, and any changes which aren't backwards compatible will force a major version bump.

Hacking

Patches are most welcome, but I'd appreciate it if you could follow the guidelines below to make it easier to integrate your changes. These are guidelines however, and as such can be broken if the need arises or you just want to convince me that your style is better.

  • PEP 8, the style guide, should be followed where possible.
  • While support for Python versions prior to v2.5 may be added in the future if such a need were to arise, you are encouraged to use v2.5 features now.
  • All new classes and methods should be accompanied by new doctest examples and reStructuredText formatted descriptions.
  • Tests must not span network boundaries, use mock if needed.
  • doctest tests in modules are only for unit testing in general, and should not rely on any modules that aren't in Python's standard library.
  • Functional tests should be in the doc directory in reStructuredText formatted files, with actual tests in doctest blocks. Functional tests can depend on external modules, but they must be Open Source.

New examples for the doc directory are as appreciated as code changes.

Bugs

If you find any problems, bugs or just have a question about this package either file an issue or drop me a mail.

If you've found a bug please attempt to include a minimal testcase so I can reproduce the problem, or even better a patch!

Something went wrong with that request. Please try again.