Introduction
birdhousebuilder.recipe.pycsw is a Buildout recipe to install and configure pycsw with Anaconda. pycsw is a Python implementation of a Catalog Service for the Web (CSW). pycsw will be deployed as a Supervisor service and is available on a Nginx web server.
This recipe is used by the Birdhouse project.
Usage
The recipe requires that Anaconda is already installed. It assumes that the default Anaconda location is in your home directory ~/anaconda. Otherwise you need to set the ANACONDA_HOME environment variable or the Buildout option anaconda-home.
It installs the pycsw package from a conda channel in a conda environment named birdhouse. The location of the birdhouse environment is .conda/envs/birdhouse. It setups a pycsw database (sqlite) in ~/.conda/envs/birdhouse/var/lib/pycsw. It deploys a Supervisor configuration for pycsw in ~/.conda/envs/birdhouse/etc/supervisor/conf.d/pycsw.conf. Supervisor can be started with ~/.conda/envs/birdhouse/etc/init.d/supervisor start.
The recipe will install the nginx package from a conda channel and deploy a Nginx site configuration for pycsw. The configuration will be deployed in ~/.conda/envs/birdhouse/etc/nginx/conf.d/pycsw.conf.
By default pycsw will be available on http://localhost:8082/csw?service=CSW&version=2.0.2&request=GetCapabilities.
The recipe depends on birdhousebuilder.recipe.conda, birdhousebuilder.recipe.supervisor and birdhousebuilder.recipe.nginx.
Supported options
The recipe supports the following options:
- anaconda-home
Buildout option with the root folder of the Anaconda installation. Default: $HOME/anaconda. The default location can also be set with the environment variable ANACONDA_HOME. Example:
export ANACONDA_HOME=/opt/anaconda
Search priority is:
1. ``anaconda-home`` in ``buildout.cfg``
2. ``$ANACONDA_HOME``
3. ``$HOME/anaconda``
- hostname
The hostname of the pycsw service (nginx). Default: localhost
- port
The port of the pycsw service (nginx). Default: 8082
- transactions
Allow transactions. Default: true
- allowed_ips
The IPs allowed to access this pycsw service. Default: 127.0.0.1
Example usage
The following example buildout.cfg installs pycsw with Anaconda:
.. code-block:: ini
[buildout] parts = pycsw
anaconda-home = /opt/anaconda
[pycsw] recipe = birdhousebuilder.recipe.pycsw hostname = localhost port = 8082
After installing with Buildout start the pycsw service with:
$ cd /home/myself/.conda/envs/birdhouse $ etc/init.d/supervisord start # start|stop|restart $ bin/supervisorctl status # check that pycsw is running $ less var/log/supervisor/pycsw.log # check log file
Open your browser with the following URL:
http://localhost:8082/csw?service=CSW&version=2.0.2&request=GetCapabilities
Change History
0.3.0 (2015-12-18)
added options allowed_ips and transactions.
updated Readme.
cleaned up buildout update mode.
0.2.3 (2015-12-15)
using ioos conda channel.
0.2.2 (2015-06-25)
added user option.
0.2.1 (2015-05-11)
merged https://github.com/bird-house/birdhousebuilder.recipe.pycsw/pull/1 (add check for PYCSW_CONFIG variable in os.environ)
0.2.0 (2015-02-24)
installing in conda enviroment birdhouse.
using $ANACONDA_HOME environment variable.
separation of anaconda-home and installation prefix.
0.1.3 (2014-08-26)
Fixed proxy configuration.
0.1.2 (2014-08-13)
Changed gunicorn template for gunicorn 19.0.
0.1.1 (2014-08-01)
Updated documentation.
0.1.0 (2014-07-29)
Initial Release.
Metadata
Release files for birdhousebuilder.recipe.pycsw 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| birdhousebuilder.recipe.pycsw-0.3.0.tar.gz | 9.7 kB | Without provenance | Details for birdhousebuilder.recipe.pycsw-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| birdhousebuilder.recipe.pycsw-0.3.0-py2-none-any.whl | Python 2 | none | any | Details for birdhousebuilder.recipe.pycsw-0.3.0-py2-none-any.whl |
Total release size: 24.4 kB
Release files / birdhousebuilder.recipe.pycsw-0.3.0.tar.gz
| Download URL | birdhousebuilder.recipe.pycsw-0.3.0.tar.gz |
|---|---|
| Size | 9.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
68cfd16fa1f5e8964531f301382a8ec38ad944bd653425793228717e9fd1b919
|
|
BLAKE2b-256 checksum How to use checksums |
b1c762068a8c70316282d411217106ade3fef2c2e7db72bb8c02277a728efca9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / birdhousebuilder.recipe.pycsw-0.3.0-py2-none-any.whl
| Download URL | birdhousebuilder.recipe.pycsw-0.3.0-py2-none-any.whl |
|---|---|
| Size | 14.6 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
dae5777e8a2dd3ada5c382bb82af0a6cc3b85e4066977f93df19fb79e663854a
|
|
BLAKE2b-256 checksum How to use checksums |
adf0fd868b43a9f45ecd42b2c37bfe4c058091397d2d22aaff1c616cdf64124b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for birdhousebuilder.recipe.pycsw 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.