Ticket #721: pycsw_quickstart.rst

File pycsw_quickstart.rst, 2.1 KB (added by tomkralidis, 13 years ago)
Line 
1:Author: OSGeo-Live
2:Author: Tom Kralidis, Angelos Tzotsos
3:Reviewer: Cameron Shorter, LISAsoft
4:Version: osgeo-live5.0
5:License: Creative Commons
6
7.. _pycsw-quickstart:
8
9.. image:: ../../images/project_logos/logo-pycsw.png
10 :scale: 100 %
11 :alt: project logo
12 :align: right
13 :target: http://pycsw.org/
14
15********************************************************************************
16pycsw Quickstart
17********************************************************************************
18
19pycsw is an OGC CSW server implementation written in `Python`_.
20
21pycsw implements clause 10 (HTTP protocol binding (Catalogue Services for the Web, CSW)) of the `OpenGIS Catalogue Service Implementation Specification`_, version 2.0.2. Initial development started in 2010 (more formally announced in `2011`_).
22
23pycsw allows for the publishing and discovery of geospatial metadata. Existing repositories of geospatial metadata can be exposed via OGC:CSW 2.0.2.
24
25pycsw is `Open Source`_, released under an MIT :ref:`license <license>`, and runs on all major platforms (Windows, Linux, Mac OS X).
26
27pycsw is an optional install on the OSGeo LiveDVD. This QuickStart will describe how to enable pycsw display the testing interface and access the pycsw endpoint.
28
29Installation
30============
31
32To install pycsw, TODO (how do we install?)
33
34Tester
35======
36
37To run the pycsw tester, open Firefox and navigate to http://localhost/pycsw/tester/index.html
38
39.. image:: /path/to/pycsw_tester.png
40
41The capabilities of the pycsw installation can be found at http://localhost/pycsw/csw.py?service=CSW&version=2.0.2&request=GetCapabilities.
42
43.. image:: /path/to/pycsw_getcapabilities_response.png
44
45For full functionality, configuration options, and adding metadata to the catalogue, please consult the `documentation`_ on the pycsw website.
46
47.. _`Python`: http://www.python.org/
48.. _`OpenGIS Catalogue Service Implementation Specification`: http://www.opengeospatial.org/standards/cat
49.. _`2011`: http://www.kralidis.ca/blog/2011/02/04/help-wanted-baking-a-csw-server-in-python/
50.. _`Open Source`: http://www.opensource.org/
51.. _`documentation`: http://pycsw.org/documentation.html