The cl-weather-jp Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-weather-jp Reference Manual

This is the cl-weather-jp Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:21:53 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-weather-jp

Build Status Coverage Status Quicklisp dist

cl-weather-jp allows you to retrieve the weather in Japan via Livedoor Weather.

Usage

(use-package :cl-weather-jp)

(city-forecasts "東京")
;=> ((("image" ("height" . 31) ("title" . "晴時々曇")
;      ("url" . "http://weather.livedoor.com/img/icon/2.gif") ("width" . 50))
;     ("temperature" ("max" ("fahrenheit" . "60.8") ("celsius" . "16")) ("min"))
;     ("date" . "2015-12-25") ("telop" . "晴時々曇") ("dateLabel" . "今日"))
;    (("image" ("height" . 31) ("title" . "晴れ")
;      ("url" . "http://weather.livedoor.com/img/icon/1.gif") ("width" . 50))
;     ("temperature" ("max" ("fahrenheit" . "57.2") ("celsius" . "14"))
;      ("min" ("fahrenheit" . "41.0") ("celsius" . "5")))
;     ("date" . "2015-12-26") ("telop" . "晴れ") ("dateLabel" . "明日"))
;    (("image" ("height" . 31) ("title" . "晴時々曇")
;      ("url" . "http://weather.livedoor.com/img/icon/2.gif") ("width" . 50))
;     ("temperature" ("max") ("min")) ("date" . "2015-12-27") ("telop" . "晴時々曇")
;     ("dateLabel" . "明後日")))

Installation

$ cd ~/common-lisp
$ git clone https://github.com/fukamachi/cl-weather-jp
(ql:quickload :cl-weather-jp)

Author

Copyright

Copyright (c) 2015 Eitaro Fukamachi (e.arrows@gmail.c


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-weather-jp

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

Get weather in Japan

Long Description

# cl-weather-jp

[![Build Status](https://travis-ci.org/fukamachi/cl-weather-jp.svg?branch=master)](https://travis-ci.org/fukamachi/cl-weather-jp) [![Coverage Status](https://coveralls.io/repos/fukamachi/cl-weather-jp/badge.svg?branch=master)](https://coveralls.io/r/fukamachi/cl-weather-jp) [![Quicklisp dist](http://quickdocs.org/badge/cl-weather-jp.svg)](http://quickdocs.org/cl-weather-jp/)

cl-weather-jp allows you to retrieve the weather in Japan via [Livedoor Weather](http://weather.livedoor.com).

## Usage

“‘common-lisp
(use-package :cl-weather-jp)

(city-forecasts "東京")
;=> ((("image" ("height" . 31) ("title" . "晴時々曇")
; ("url" . "http://weather.livedoor.com/img/icon/2.gif") ("width" . 50))
; ("temperature" ("max" ("fahrenheit" . "60.8") ("celsius" . "16")) ("min"))
; ("date" . "2015-12-25") ("telop" . "晴時々曇") ("dateLabel" . "今日"))
; (("image" ("height" . 31) ("title" . "晴れ")
; ("url" . "http://weather.livedoor.com/img/icon/1.gif") ("width" . 50))
; ("temperature" ("max" ("fahrenheit" . "57.2") ("celsius" . "14"))
; ("min" ("fahrenheit" . "41.0") ("celsius" . "5")))
; ("date" . "2015-12-26") ("telop" . "晴れ") ("dateLabel" . "明日"))
; (("image" ("height" . 31) ("title" . "晴時々曇")
; ("url" . "http://weather.livedoor.com/img/icon/2.gif") ("width" . 50))
; ("temperature" ("max") ("min")) ("date" . "2015-12-27") ("telop" . "晴時々曇")
; ("dateLabel" . "明後日")))
“‘

## Installation

“‘
$ cd ~/common-lisp
$ git clone https://github.com/fukamachi/cl-weather-jp
“‘

“‘common-lisp
(ql:quickload :cl-weather-jp)
“‘

## Author

* Eitaro Fukamachi (e.arrows@gmail.com)

## Copyright

Copyright (c) 2015 Eitaro Fukamachi (e.arrows@gmail.com)

## License

Licensed under the BSD 2-Clause License.

Version

0.1

Dependencies
Source

cl-weather-jp.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 cl-weather-jp/src

Parent

cl-weather-jp (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-weather-jp.asd

Location

cl-weather-jp.asd

Systems

cl-weather-jp (system)

Packages

cl-weather-jp-asd


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 cl-weather-jp/src/cl-weather-jp.lisp

Dependencies
Parent

src (module)

Location

src/cl-weather-jp.lisp

Packages

cl-weather-jp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 cl-weather-jp/src/location.lisp

Dependencies
Parent

src (module)

Location

src/location.lisp

Packages

cl-weather-jp.location

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 cl-weather-jp/src/http.lisp

Parent

src (module)

Location

src/http.lisp

Packages

cl-weather-jp.http

Exported Definitions

http-get (function)

Internal Definitions

*default-user-agent* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 cl-weather-jp/src/error.lisp

Parent

src (module)

Location

src/error.lisp

Packages

cl-weather-jp.error

Exported Definitions

unknown-location (condition)


Previous: , Up: Lisp files   [Contents][Index]

4.1.6 cl-weather-jp/src/util.lisp

Parent

src (module)

Location

src/util.lisp

Packages

cl-weather-jp.util

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 cl-weather-jp-asd

Source

cl-weather-jp.asd

Use List

Next: , Previous: , Up: Packages   [Contents][Index]

5.2 cl-weather-jp

Source

cl-weather-jp.lisp (file)

Use List
Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.3 cl-weather-jp.location

Source

location.lisp (file)

Use List
Used By List

cl-weather-jp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.4 cl-weather-jp.http

Source

http.lisp (file)

Use List

common-lisp

Used By List

cl-weather-jp.location

Exported Definitions

http-get (function)

Internal Definitions

*default-user-agent* (special variable)


Next: , Previous: , Up: Packages   [Contents][Index]

5.5 cl-weather-jp.error

Source

error.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions

unknown-location (condition)


Previous: , Up: Packages   [Contents][Index]

5.6 cl-weather-jp.util

Source

util.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: aget ALIST KEY &key TEST
Function: (setf aget) VAL ALIST KEY &key TEST
Package

cl-weather-jp.util

Source

util.lisp (file)

Function: city-forecast-detail-url CITY
Package

cl-weather-jp

Source

cl-weather-jp.lisp (file)

Function: city-forecasts CITY
Package

cl-weather-jp

Source

cl-weather-jp.lisp (file)

Function: http-get URL
Package

cl-weather-jp.http

Source

http.lisp (file)

Function: retrieve-city-id CITY
Package

cl-weather-jp.location

Source

location.lisp (file)

Function: retrieve-city-weather CITY
Package

cl-weather-jp.location

Source

location.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Conditions

Condition: unknown-location ()
Package

cl-weather-jp.error

Source

error.lisp (file)

Direct superclasses

error (condition)

Direct slots
Slot: location
Initargs

:location


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *area-info-cache*
Package

cl-weather-jp.location

Source

location.lisp (file)

Special Variable: *default-user-agent*
Package

cl-weather-jp.http

Source

http.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: area-info ()
Package

cl-weather-jp.location

Source

location.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-weather-jp.asd: The cl-weather-jp<dot>asd file
cl-weather-jp/src: The cl-weather-jp/src module
cl-weather-jp/src/cl-weather-jp.lisp: The cl-weather-jp/src/cl-weather-jp<dot>lisp file
cl-weather-jp/src/error.lisp: The cl-weather-jp/src/error<dot>lisp file
cl-weather-jp/src/http.lisp: The cl-weather-jp/src/http<dot>lisp file
cl-weather-jp/src/location.lisp: The cl-weather-jp/src/location<dot>lisp file
cl-weather-jp/src/util.lisp: The cl-weather-jp/src/util<dot>lisp file

F
File, Lisp, cl-weather-jp.asd: The cl-weather-jp<dot>asd file
File, Lisp, cl-weather-jp/src/cl-weather-jp.lisp: The cl-weather-jp/src/cl-weather-jp<dot>lisp file
File, Lisp, cl-weather-jp/src/error.lisp: The cl-weather-jp/src/error<dot>lisp file
File, Lisp, cl-weather-jp/src/http.lisp: The cl-weather-jp/src/http<dot>lisp file
File, Lisp, cl-weather-jp/src/location.lisp: The cl-weather-jp/src/location<dot>lisp file
File, Lisp, cl-weather-jp/src/util.lisp: The cl-weather-jp/src/util<dot>lisp file

L
Lisp File, cl-weather-jp.asd: The cl-weather-jp<dot>asd file
Lisp File, cl-weather-jp/src/cl-weather-jp.lisp: The cl-weather-jp/src/cl-weather-jp<dot>lisp file
Lisp File, cl-weather-jp/src/error.lisp: The cl-weather-jp/src/error<dot>lisp file
Lisp File, cl-weather-jp/src/http.lisp: The cl-weather-jp/src/http<dot>lisp file
Lisp File, cl-weather-jp/src/location.lisp: The cl-weather-jp/src/location<dot>lisp file
Lisp File, cl-weather-jp/src/util.lisp: The cl-weather-jp/src/util<dot>lisp file

M
Module, cl-weather-jp/src: The cl-weather-jp/src module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   C   F   H   R  
Index Entry  Section

(
(setf aget): Exported functions

A
aget: Exported functions
area-info: Internal functions

C
city-forecast-detail-url: Exported functions
city-forecasts: Exported functions

F
Function, (setf aget): Exported functions
Function, aget: Exported functions
Function, area-info: Internal functions
Function, city-forecast-detail-url: Exported functions
Function, city-forecasts: Exported functions
Function, http-get: Exported functions
Function, retrieve-city-id: Exported functions
Function, retrieve-city-weather: Exported functions

H
http-get: Exported functions

R
retrieve-city-id: Exported functions
retrieve-city-weather: Exported functions

Jump to:   (  
A   C   F   H   R  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
L   S  
Index Entry  Section

*
*area-info-cache*: Internal special variables
*default-user-agent*: Internal special variables

L
location: Exported conditions

S
Slot, location: Exported conditions
Special Variable, *area-info-cache*: Internal special variables
Special Variable, *default-user-agent*: Internal special variables

Jump to:   *  
L   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S   U  
Index Entry  Section

C
cl-weather-jp: The cl-weather-jp system
cl-weather-jp: The cl-weather-jp package
cl-weather-jp-asd: The cl-weather-jp-asd package
cl-weather-jp.error: The cl-weather-jp<dot>error package
cl-weather-jp.http: The cl-weather-jp<dot>http package
cl-weather-jp.location: The cl-weather-jp<dot>location package
cl-weather-jp.util: The cl-weather-jp<dot>util package
Condition, unknown-location: Exported conditions

P
Package, cl-weather-jp: The cl-weather-jp package
Package, cl-weather-jp-asd: The cl-weather-jp-asd package
Package, cl-weather-jp.error: The cl-weather-jp<dot>error package
Package, cl-weather-jp.http: The cl-weather-jp<dot>http package
Package, cl-weather-jp.location: The cl-weather-jp<dot>location package
Package, cl-weather-jp.util: The cl-weather-jp<dot>util package

S
System, cl-weather-jp: The cl-weather-jp system

U
unknown-location: Exported conditions

Jump to:   C   P   S   U