sflib 1.0dev-BZR-r33-panta-elasticworld.org-20081211100211-4mfujx2caqli3dka

Foundation library for SoftwareFabrica projects

Python sflib
============

A library of (hopefully) useful python modules.

SoftwareFabrica sflib is a library of (hopefully) useful python modules. It
provides support for object-oriented HTML generation, an ultra-simple DOM
library, graph classes and algorithms, object-oriented Patterns, and more.

Your help and feedback is precious. Please get in touch with us for your
suggestions.

If you want to actively collaborate and provide code, documentation, tests or
bug fixes, please feel free to create a new Bazaar branch in Launchpad, and tell
us about it! See the collaboration_ section for more information.


*Marco Pantaleoni*

.. contents::

.. _installation:

INSTALLATION
------------

You can download and install the most up-to-date version in one step
using EasyInstall_. For example, on a unix-like system:

::

$ su
# easy_install sflib

If you are using Ubuntu, to install system-wide:

::

$ sudo easy_install sflib

Otherwise you can just download the source package (eg. from PyPI_),
extract it and run the usual ``setup.py`` commands:

::

$ su
# python setup.py install

.. _EasyInstall: http://peak.telecommunity.com/DevCenter/EasyInstall
.. _PyPI: http://pypi.python.org/pypi

.. _download:

DOWNLOAD
--------

If you don't want or cannot install using EasyInstall_, download the
package from Cheese Shop:

http://pypi.python.org/pypi/sflib/

http://cheeseshop.python.org/pypi/sflib/

In a future, it will be possible to download also from:

http://www.softwarefabrica.org/projects/sflib/


.. _documentation:

DOCUMENTATION
-------------

Documentation is included in the form of *docstrings*, inside the library source
code.

For some advanced examples, please see also the included automatic tests.

.. _collaboration:

COLLABORATION
-------------

As said, your help is precious. We'll warmly appreciate any help you'll want to
give. Just using this library is a reward for us, but if you want to become more
actively involved, tell us!

The project has a `development home page`_ at `LaunchPad`_:

https://launchpad.net/sflib

There you can file `bugs`_, follow development or ask to become an active team
member.

You can checkout the development branch using `Bazaar`_:

::

bzr branch lp:sflib

We'll appreciate very much if you'll want to contribute back any changes. Just
register you branch with `LaunchPad`_ and thell us!

Source code can also be browsed `online`_.

.. _`development home page`: https://launchpad.net/sflib
.. _`bugs`: https://bugs.launchpad.net/sflib
.. _`LaunchPad`: http://launchpad.net
.. _`Bazaar`: http://bazaar-vcs.org/
.. _`online`: http://bazaar.launchpad.net/~softwarefabrica/sflib/trunk/changes

.. _contacts:

CONTACTS
--------

It's possible to contact the team by e-mail at the following address:

team at softwarefabrica.it

It's possible to contact the author by e-mail at the following addresses:

m.pantaleoni at softwarefabrica.org

panta at elasticworld.org

marco.pantaleoni at gmail.com


.. _license:

LICENSE
-------

This software is covered by the GNU General Public License version 2.
If you want to use this software in a closed source application, you
need to buy a commercial license from the author.

This open source version is:

Copyright (C) 2007-2008 Marco Pantaleoni. All rights reserved.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2 as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


CHANGES
-------

2008-12-11 Marco Pantaleoni <[e-mail]>

* README.txt: updated with launchpad info.

2008-11-24 Marco Pantaleoni <[e-mail]>

* sflib/version.py (get_version_setuptools): use '-' instead of
'_'.
Made get_version() and get_version_setuptools() more generic.

* Improved setuptools versioning.

2008-11-20 Marco Pantaleoni <[e-mail]>

* integrated nose testing framework.

* README.txt: added installation instructions.

* removed ez_setup.py and setuptools bootstrapping since it seemed
to cause problems with virtualenv.

* changed directory layout, to allow easy packaging.

* integrated setuptools support.

2008-11-19 Marco Pantaleoni <[e-mail]>

* udom: added - a micro DOM library.

* delegate.py: added - a modern delegate pattern library.

* fileconf: added - this is a flexible configuration
file support library.

2008-06-12 Marco Pantaleoni <[e-mail]>

* ps.py: added (library to handle/access processes using /proc).

* dictclass.py: added ("a base class that acts like a
dictionary, but saves to instance variables.")

2008-04-26 Marco Pantaleoni <[e-mail]>

* html.py: renamed getElementName() into getElementTagName().

2008-04-25 Marco Pantaleoni <[e-mail]>

* html.py: added some DOM navigation functions.

2008-04-06 Marco Pantaleoni <[e-mail]>

* visitor.py: implemented fallback operations.

2008-04-05 Marco Pantaleoni <[e-mail]>

* html.py: made fieldset and legend line entities.

* visitor.py: added. This implements a modern version of the
visitor pattern.

2008-04-02 Marco Pantaleoni <[e-mail]>

* html.py: added output indentation.

2008-03-09 Marco Pantaleoni <[e-mail]>

* aviation.py: implemented and added.
Added lat_hms, lon_hms keyword construction to Point.

2008-03-07 Marco Pantaleoni <[e-mail]>

* html.py: added empty tags class generation.
Added COMMENT().
Added some tests.

* added graph and queues.

* html.py: Created.

* Created.