bag library¶
bag contains code for many purposes, which I find myself reusing in multiple programs – so this code must be version-controlled. I use SQLAlchemy and Pyramid a lot.
Documentation is at http://docs.nando.audio/bag/latest/
The code is at https://github.com/nandoflorestan/bag where you can do your bug reports and pull requests.
This version of bag was published with releaser.
Most important library contents¶
bag.spreadsheet – Import CSV and Excel spreadsheets based on headers on the first row. There is also a buffered CSV writer for outputting CSV in a web app.
bag.email_validator – The ultimate functions for email validation and domain validation, as well as an email address harvester.
bag.pathlib_complement – A Path subclass that does what pathlib doesn’t do.
bag.subcommand – Use argh to dispatch to subcommands with their command-line arguments.
bag.web.burla – Powerful URL generation independent of web frameworks, working in Python and in the client (Javascript) too. Also provided is Pyramid integration for it.
bag.web.transecma – Complete solution for javascript internationalization. Compatible with jquery templates. Includes transecma.js.
bag.web.flash_msg has been removed in favor of a better module in the kerno library. It defines a rich class for UI messages to be stored in the HTTP session.
If you use the Pyramid web framework¶
bag.web.pyramid.angular_csrf – Make Pyramid play ball with AngularJS to achieve CSRF protection.
bag.web.pyramid.locale – Easily enable and disable locales, let users switch languages, and use the browser’s languages by default.
bag.web.pyramid.nav – Simple web menu system (navigation).
bag.web.pyramid.plugins_manager – Make your Pyramid app extensible through plugins.
bag.web.exceptions – The Problem exception is good for throwing from a service layer, then caught in the view layer to be shown to the user. – Functions and base resources for context objects (Pyramid traversal).
bag.web.pyramid.routes – Make Pyramid routes and the route_path() function available to JS in the client.
If you use SQLAlchemy¶
bag.sqlalchemy.context – Convenient SQLAlchemy initialization, at last.
bag.sqlalchemy.mediovaigel – Complete solution for database fixtures using SQLAlchemy.
bag.sqlalchemy.tricks – Various SQLAlchemy gimmicks, including a great base model class.
Commands¶
delete_old_branches – Deletes git branches that have already been merged onto the current branch. Optionally, filter the branches by age (in days).
reorder_po – Reorders .po files (usually after transifex messes up the order of the translations in them) so the diff is always readable.
replace_text – A simple command to replace text in many files, without worrying about regular expressions.
Less important library contents¶
bag.check_rst – Verifies reStructuredText content for correctness.
bag.console – Functions for user interaction at the console.
bag.corrupt_image – Read image files and do something if they are corrupt.
bag.file_existence_manager – Tools for finding duplicate files using hashes.
bag.log – Convenient logging initialization.
bag.html – Encode and decode HTML and XML entities.
bag.more_codecs – Got text in some weird encoding that Python doesn’t know? OK, use iconv to decode it.
bag.show_progress – Don’t leave your user wondering if your program is hanging; print the progress every few seconds.
bag.streams – Functions that use streams (open files).
bag.text – Functions for working with unicode strings.
bag.text.words – Contains lists of nouns and adjectives and can generate a random combination words – good for generating funny test data.
bag.time – Functions to make it easier to work with datetimes. Includes a JSON encoder that supports time, datetime and Decimal.
Compiling the documentation¶
Install make, activate your virtualenv, and then:
pip install sphinx sphinx-autodoc-typehints
./build_sphinx_documentation.sh