shell

Planet CRS Registry

The coordinates reference system registry for solar bodies

Stable release

To install Planet CRS Registry, run this command in your terminal:

$ pip install planet_crs_registry

This is the preferred method to install Planet CRS Registry, as it will always install the most recent stable release.

If you don't have pip installed, this Python installation guide can guide you through the process.

From sources (without virtual environment) ------------

The sources for Planet CRS Registry can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/pdssp/planet_crs_registry

Or download the tarball:

$ curl -OJL https://github.com/pdssp/planet_crs_registry/tarball/master

Once you have a copy of the source, you can install it with:

$ make  # install in the system root
$ make user # or Install for non-root usage

From sources (with virtual environment) ------------

The sources for Planet CRS Registry can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/pdssp/planet_crs_registry

Or download the tarball:

$ curl -OJL https://github.com/pdssp/planet_crs_registry/tarball/master

Once you have a copy of the source, you can install it with:

$ make prepare-dev
$ source .planet_crs_registry # Use the virtual environment
$ make

Development

$ git clone https://github.com/pdssp/planet_crs_registry
$ cd planet_crs_registry
$ make prepare-dev
$ source .planet_crs_registry
$ make install-dev

To get more information about the preconfigured tasks:

$ make help

Usage

To use Planet CRS Registry in a project:

planet_crs_registry

Docker

$ docker pull pdssp/planetary-crs-registry # get the image

### Run the registry as Http

$ docker run -p 8080:8080 pdssp/planetary-crs-registry

### Run the registry as Https

Create the SSL certificate

$ mkdir -p /tmp/conf
$ cd /tmp/conf
$ mkcert -cert-file cert.pem -key-file key.pem 0.0.0.0 localhost 127.0.0.1 ::1

Edit the configuration file

$ vi /tmp/conf/planet_crs_registry.conf

And set the configuration file as follows:

` [HTTPS] host = 0.0.0.0 port = 5000 ssl_keyfile = key.pem ssl_certfile = cert.pem` Create the container

$ docker run --name=pdssp-planet_crs_registry -p 5000:5000 -v /tmp/conf:/conf pdssp/planet_crs_registry

### Run the registry as both Http and Https

Create the SSL certificate

$ mkdir -p /tmp/conf
$ cd /tmp/conf
$ mkcert -cert-file cert.pem -key-file key.pem 0.0.0.0 localhost 127.0.0.1 ::1

Edit the configuration file

$ vi /tmp/conf/planet_crs_registry.conf

And set the configuration file as follows:

` [HTTP] host = 0.0.0.0 port = 8080 [HTTPS] host = 0.0.0.0 port = 5000 ssl_keyfile = key.pem ssl_certfile = cert.pem` Create the container

$ docker run --name=pdssp-planet_crs_registry -p 5000:5000 -p 8080:8080 -v /tmp/conf:/conf pdssp/planet_crs_registry

### Stop the registry

$ docker stop pdssp-planet_crs_registry

### Restart the registry

$ docker start pdssp-planet_crs_registry

Run tests

$make tests

Author

👤 Jean-Christophe Malapert

🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/pole-surfaces-planetaires/planet_crs_registry/issues). You can also take a look at the [contributing guide](https://github.com/pole-surfaces-planetaires/planet_crs_registry/blob/master/CONTRIBUTING.rst)

📝 License

This project is [GNU Lesser General Public License v3](https://github.com/pole-surfaces-planetaires/planet_crs_registry/blob/master/LICENSE) licensed.