Skip to content

Latest commit

 

History

History
82 lines (42 loc) · 3.73 KB

README.textile

File metadata and controls

82 lines (42 loc) · 3.73 KB
Raw

Marrow Tags

An object-based template and widget library wherein templates are interpreted by Python itself.

© 2010-2011, Alice Bevan-McGregor

https://github.com/pulp/marrow.tags

1. What is Marrow Tags?

The marrow.tags package offers pure-Python HTML (and other) text generation and a library of small reusable widgets. The following are a list of features:

  • No additional languages to learn: it’s all Python.
    • You benefit from Python’s opcode generation and caching systems.
    • Compatible with all Python interpreters: CPython, Jython, etc.
  • Usable as a templating engine:
    • Extremely light-weight.
    • Utilizes Python’s existing package management infrastructure.
    • Your templates can be packaged within a zipped EGG file.
  • Generated text is optionally beautifully indented and clean.
  • Out-of-the-box support for pipe-based filters.
  • Plays well with others: templates (and widgets) can be treated as unicode strings.
  • Fully unit tested.
  • Compatible with Python 2.6+ and 3.1+.

2. Installation

Installing marrow.tags is easy, just execute the following in a terminal:

pip install marrow.tags

If you add marrow.tags to the install_requires argument of the call to setup() in your application’s setup.py file, marrow.tags will be automatically installed and made available when your own application is installed.

2.1. Development Version

Development takes place on GitHub in the marrow.tags project. Issue tracking, documentation, and downloads are provided there.

Installing the current development version requires Git, a distributes source code management system. If you have Git, you can run the following to download and link the development version into your Python runtime:

git clone https://github.com/pulp/marrow.tags.git
(cd marrow.tags; python setup.py develop)

You can upgrade to the latest version at any time:

(cd marrow.blueprint; git pull; python setup.py develop)

If you would like to make changes and contribute them back to the project, fork the GitHub project, make your changes, and submit a pull request. This process is beyond the scope of this documentation; for more information, see GitHub’s documentation.

3. Basic Usage

5. License

Marrow Tags has been released under the MIT Open Source license.

5.1. The MIT License

Copyright © 2010-2011 Alice Bevan-McGregor and contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.