README.org 4.33 KB
Newer Older
1
2
* Get infos about hackerspaces

Gendre Sébastien's avatar
Gendre Sébastien committed
3
4
  Get some informations about hackerspaces, makerspaces, fablabs, etc,
  by using the Spacedirectory.org and the Space API.
5

Gendre Sébastien's avatar
Gendre Sébastien committed
6
  Provide 2 tools:
7
8
9
  - A command line software, nammed =spacedirectory=
  - A Python module, also nammed =spacedirectory=, that you can use in
    your Python softwares
10
11
12
13
14
15

** Features

*** Command line
    
    - Get the list of spaces from spacedirectory
16
17
18
    - Get, in one time, infos of a given space name
    - Get infos of a given Space API
    - Infos you can get on the terminal (ony what space publish):
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
      - Name
      - Website URL
      - Status
	- If open
	- Last time the status changed
	- The person who lastly changed the state
	- Status message
      - Location
	- Postal address
	- Latitude
	- Longitude
      - Contact
	- Phone number
	- SIP URL
	- IRC channel URL
	- Public Jabber/XMPP multi-user chatroom
	- Twitter account
	- Identi.ca or StatusNet account
	- Mailing list address
	- E-mail address for contacting
	- E-mail address for issue reports
40
    - Get a dump of space data in JSON (as get from his Space API)
41
42
43

*** Python module

44
    - Compatible with Space API V0.13 
45
46
    - Get the list of spaces, and their Space API URL, from
      spacedirectory
47
48
    - Get a Python object (spacedirectory.Space) with infos of a given
      space name or a given JSON data (ony what space publish):
49
50
51
52
53
54
55
56
      - Name
      - Logo URL
      - Website URL
      - Status
	- If open
	- Last time the status changed
	- The person who lastly changed the state
	- Status message
57
	- Open and close logo URL
58
59
60
61
62
63
64
65
66
67
68
69
70
71
      - Location
	- Postal address
	- Latitude
	- Longitude
      - Contact
	- Phone number
	- SIP URL
	- IRC channel URL
	- Public Jabber/XMPP multi-user chatroom
	- Twitter account
	- Identi.ca or StatusNet account
	- Mailing list address
	- E-mail address for contacting
	- E-mail address for issue reports
72
    - Get a dump of spacedirectory.Space data in JSON
73
74


75
76
** Install

77
78
79
80
81
82
83
84
85
*** From the Python Package Index

    #+BEGIN_SRC sh
      pip3 install --user spacedirectory
    #+END_SRC

    Remove the =--user= flag from =pip3= command if you use a virtual
    environement, or if you want to install on system side.

86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
*** From source

    #+BEGIN_SRC sh
      git clone https://framagit.org/SebGen/spacedirectory.git
      cd spacedirectory
      pip3 install --user .
    #+END_SRC

    Remove the =--user= flag from =pip3= command if you use a virtual
    environement, or if you want to install on system side.

    You can also install directly from the source repo:
    #+BEGIN_SRC sh
      pip3 install --user git+https://framagit.org/SebGen/spacedirectory
    #+END_SRC

102
103
104
105
** Usage

*** Command line

106
107
108
109
110
111
112
**** Get the list of spaces known by Space Directory
     
     Simply call the program:
     #+BEGIN_SRC sh
     spacedirectory
     #+END_SRC
     
113
     Or call the program with the command =list=:
114
     #+BEGIN_SRC sh
115
       spacedirectory list
116
117
118
119
     #+END_SRC
    
**** Get infos of a space
     
120
     Simply call the program with the command =info= and the space name:
121
     #+BEGIN_SRC sh
122
       spacedirectory info "space name"
123
124
125
126
     #+END_SRC
    
**** Get infos of a space api
    
127
     Call the program with the command =info= and with option =-a= or =--api=:
128
     #+BEGIN_SRC sh
129
       spacedirectory info -a "api url"
130
131
132
133
     #+END_SRC
    
**** Get a dump of an asked space infos in JSON

134
     Call the program with the command =info= and with flag =-j= or =--json=:
135
     #+BEGIN_SRC sh
136
       spacedirectory info "space name" -j
137
138
139
     #+END_SRC
    

140
141
*** Python module

142
143
    See file [[file:doc/modules/usage.org][doc/modules/usage.org]]

144
145
** About 

146
147
148
149
150
151
152
153
*** Space Directory
    
    Space Directory project, or Spacedirectory.org, is a friendly fork
    of the [[http://spaceapi.net/][Space API]] project that was started during [[https://en.wikipedia.org/wiki/Chaos_Communication_Congress][33c3]] by people
    from [[https://www.coredump.ch/][Coredump]] and [[https://fixme.ch/][Fixme]].
    
    You can find more informations, the Space API specification and
    the directory at: https://spacedirectory.org/
154
155
156

*** Space API

157
158
159
160
161
    The purpose of the Space API is to define a unified REST API
    specification across the hackerspaces, makerspaces, fablabs,
    chaostreffs and the like across the world that can be used to
    expose information to web apps or any other application.

162
163
164
165
166
167
168
169
** Licence

   GPLv3

** Author

   Sébastien Gendre <seb@k-7.ch>