<commit_before>pycsw-workshop
==============

pycsw Workshop<commit_msg>add install notes<commit_after>pycsw-workshop
==============

Background
----------

The initial pycsw workshop materials were created through funding provided by the 
[Oregon Coastal Management Program](http://www.oregon.gov/lcd/ocmp/Pages/index.aspx), 
through an FGDC CAP grant, in 2013.

Structure
---------

Workshop documentation is stored in reStructuredText.  HTML output is generated 
through the Sphinx documentation utility.

Installation
------------

1. Install [Sphinx](http://sphinx-doc.org/)

     `easy_install Sphinx`
       
2. Install the [Bootstrap theme](https://github.com/ryan-roemer/sphinx-bootstrap-theme#installation) for Sphinx
 
     `easy_install sphinx_bootstrap_theme`

3. Install rst2pdf

     `easy_install rst2pdf`
       
4. Clone the pycsw repository locally

     `git clone <EMAIL>:geopython/pycsw-workshop.git pycsw-workshop`
       
Generating HTML Output
----------------------

1. cd into *pycsw-workshop* directory

2. execute:

     `make html`
     
3. HTML output is in the *_build* directory

Generating PDF Output
---------------------

1. cd into *pycsw-workshop* directory

2. execute:

     `sphinx-build -b pdf . _build`
     
3. *pycsw-Workshop.pdf* should have been created in the *_build* directory

Useful External References
--------------------------

* reStructuredText Reference Guide: http://docutils.sourceforge.net/docs/user/rst/quickref.html
* List of Python Packages: https://pypi.python.org/pypi?%3Aaction=index

License
-------

Copyright (c) 2013 pycsw Team

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 NONINFRINGEMENT. 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.
{'fraction_non_alphanumeric': 0.11136536994660565, 'fraction_numerical': 0.008009153318077803, 'mean_word_length': 3.514629948364888, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 2, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6997957', 'n_tokens_mistral': 760, 'n_tokens_neox': 711, 'n_words': 299}