Get informations about (hacker)spaces from the Spacedirectory (or a Space API)
Project description
* Get infos about hackerspaces
Get some informations about hackerspaces, makerspaces, fablabs, etc,
by using the Spacedirectory.org and the Space API.
Provide 2 tools:
- A command line software, nammed =spacedirectory=
- A Python module, also nammed =spacedirectory=, that you can use in
your Python softwares
** Features
*** Command line
- Get the list of spaces from spacedirectory
- 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):
- 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
- Get a dump of space data in JSON (as get from his Space API)
*** Python module
- Compatible with Space API V0.13
- Get the list of spaces, and their Space API URL, from
spacedirectory
- Get a Python object (spacedirectory.Space) with infos of a given
space name or a given JSON data (ony what space publish):
- Name
- Logo URL
- Website URL
- Status
- If open
- Last time the status changed
- The person who lastly changed the state
- Status message
- Open and close logo URL
- 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
- Get a dump of spacedirectory.Space data in JSON
** Install
*** 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.
*** 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
** Usage
*** Command line
**** Get the list of spaces known by Space Directory
Simply call the program:
#+BEGIN_SRC sh
spacedirectory
#+END_SRC
Or call the program with flag =-l= or =--list-spaces=:
#+BEGIN_SRC sh
spacedirectory -l
#+END_SRC
**** Get infos of a space
Simply write the space name:
#+BEGIN_SRC sh
spacedirectory "space name"
#+END_SRC
**** Get infos of a space api
With option =-a= or =--api=:
#+BEGIN_SRC sh
spacedirectory -a "api url"
#+END_SRC
**** Get a dump of an asked space infos in JSON
With flag =-j= or =--json=:
#+BEGIN_SRC sh
spacedirectory "space name" -j
#+END_SRC
*** Python module
See file [[file:doc/modules/usage.org][doc/modules/usage.org]]
** About
*** 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/
*** Space API
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.
** Licence
GPLv3
** Author
Sébastien Gendre <seb@k-7.ch>
Get some informations about hackerspaces, makerspaces, fablabs, etc,
by using the Spacedirectory.org and the Space API.
Provide 2 tools:
- A command line software, nammed =spacedirectory=
- A Python module, also nammed =spacedirectory=, that you can use in
your Python softwares
** Features
*** Command line
- Get the list of spaces from spacedirectory
- 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):
- 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
- Get a dump of space data in JSON (as get from his Space API)
*** Python module
- Compatible with Space API V0.13
- Get the list of spaces, and their Space API URL, from
spacedirectory
- Get a Python object (spacedirectory.Space) with infos of a given
space name or a given JSON data (ony what space publish):
- Name
- Logo URL
- Website URL
- Status
- If open
- Last time the status changed
- The person who lastly changed the state
- Status message
- Open and close logo URL
- 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
- Get a dump of spacedirectory.Space data in JSON
** Install
*** 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.
*** 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
** Usage
*** Command line
**** Get the list of spaces known by Space Directory
Simply call the program:
#+BEGIN_SRC sh
spacedirectory
#+END_SRC
Or call the program with flag =-l= or =--list-spaces=:
#+BEGIN_SRC sh
spacedirectory -l
#+END_SRC
**** Get infos of a space
Simply write the space name:
#+BEGIN_SRC sh
spacedirectory "space name"
#+END_SRC
**** Get infos of a space api
With option =-a= or =--api=:
#+BEGIN_SRC sh
spacedirectory -a "api url"
#+END_SRC
**** Get a dump of an asked space infos in JSON
With flag =-j= or =--json=:
#+BEGIN_SRC sh
spacedirectory "space name" -j
#+END_SRC
*** Python module
See file [[file:doc/modules/usage.org][doc/modules/usage.org]]
** About
*** 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/
*** Space API
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.
** Licence
GPLv3
** Author
Sébastien Gendre <seb@k-7.ch>
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
spacedirectory-0.0.1.tar.gz
(6.7 kB
view hashes)
Built Distribution
Close
Hashes for spacedirectory-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 813280fe1d225cb250ebb3ff6a2115e4b8a79cadd7ebc4556c67eae2b5f265cf |
|
MD5 | bdc7227c1b9ec1f96b14a3583b6ac031 |
|
BLAKE2b-256 | e6f526ae7e4e1ae1730b4c1cd519c8014606b41d6672ac5b048915b666d11963 |