All Projects → vrk-kpa → api-catalog

vrk-kpa / api-catalog

Licence: MIT license
API Catalog for Suomi.fi Data Exchange Layer

Programming Languages

HTML
75241 projects
python
139335 projects - #7 most used programming language
javascript
184084 projects - #8 most used programming language
Less
1899 projects
Jinja
831 projects
shell
77523 projects

Projects that are alternatives of or similar to api-catalog

opendata
Finland national open data portal (avoindata.fi) source code.
Stars: ✭ 27 (+80%)
Mutual labels:  finland, ckan
odufrn-downloader
Pacote para baixar os dados do portal de dados abertos da UFRN
Stars: ✭ 31 (+106.67%)
Mutual labels:  ckan
ckanext-pages
A simple builtin CMS for CKAN sites
Stars: ✭ 44 (+193.33%)
Mutual labels:  ckan
easyckan
The easiest way to install CKAN platform.
Stars: ✭ 32 (+113.33%)
Mutual labels:  ckan
rhdx
R package to interact with the Humanitarian Data Exchange portal - http://dickoa.gitlab.io/rhdx/
Stars: ✭ 20 (+33.33%)
Mutual labels:  ckan
ckan-php-manager
A tool for managing a CKAN data catalog
Stars: ✭ 14 (-6.67%)
Mutual labels:  ckan
ckanext-datarequests
A plugin that allows users to request data that is not published yet
Stars: ✭ 15 (+0%)
Mutual labels:  ckan
suomi.dev
Like Hacker News, but for Finns!
Stars: ✭ 27 (+80%)
Mutual labels:  finland
ckanext-validation
CKAN extension for validating Data Packages using Table Schema.
Stars: ✭ 26 (+73.33%)
Mutual labels:  ckan
qsv
CSVs sliced, diced & analyzed.
Stars: ✭ 438 (+2820%)
Mutual labels:  ckan
aircan
💨🥫 A Data Factory system for running data processing pipelines built on AirFlow and tailored to CKAN. Includes evolution of DataPusher and Xloader for loading data to DataStore.
Stars: ✭ 24 (+60%)
Mutual labels:  ckan
CFAN
The Cool Factorio Archive Network
Stars: ✭ 14 (-6.67%)
Mutual labels:  ckan
Portal.js
🌀 Next generation Javascript framework for rapidly building rich data portals.
Stars: ✭ 2,002 (+13246.67%)
Mutual labels:  ckan
Ckan
CKAN is an open-source DMS (data management system) for powering data hubs and data portals. CKAN makes it easy to publish, share and use data. It powers catalog.data.gov, open.canada.ca/data, data.humdata.org among many other sites.
Stars: ✭ 3,223 (+21386.67%)
Mutual labels:  ckan
datos.gob.es
Código perteneciente al portal español de Datos Abiertos datos.gob.es.
Stars: ✭ 20 (+33.33%)
Mutual labels:  ckan
ckan-helm
Helm chart for CKAN
Stars: ✭ 15 (+0%)
Mutual labels:  ckan
ckanext-scheming
Easy, shareable custom CKAN schemas
Stars: ✭ 67 (+346.67%)
Mutual labels:  ckan
launch-pad
A Mod Manager for Kerbal Space Program on macOS
Stars: ✭ 19 (+26.67%)
Mutual labels:  ckan
docker-ckan
CKAN docker images, docker-compose and examples
Stars: ✭ 46 (+206.67%)
Mutual labels:  ckan
ckanext-ldap
A CKAN extension that provides LDAP authentication.
Stars: ✭ 31 (+106.67%)
Mutual labels:  ckan

API Catalog (Liityntäkatalogi)

This repository provides the API catalog of the Finnish National Data Exchange Layer (Suomi.fi palveluväylä). The catalog provides a search engine for the interfaces available on the data exchange layer.

The catalog is available at liityntakatalogi.suomi.fi. A development sandbox of the catalog is available at liityntakatalogi.qa.suomi.fi

Getting started

Prerequisites:

Clone the repository and its submodules, and start Vagrant:

git clone https://github.com/vrk-kpa/api-catalog.git
cd api-catalog/
git submodule update --init --recursive
vagrant up

After Ansible provisions the system, the service will be running in the virtual machine and is available from your host machine at https://10.100.10.10/

User credentials for an administrator are admin:admin, and test:test for a regular user.

To reprovision the server (i.e. to run Ansible) again:

vagrant provision

You can ssh into the server:

vagrant ssh

And you can also run Ansible manually inside the virtual machine:

vagrant ssh
cd /src/ansible
ansible-playbook -v -i inventories/vagrant deploy-all.yml

Development

With Vagrant, the host machine shares the working directory into the virtual machine. The web server uses the CKAN extensions directly from the source code via symlinks. Depending on what you change however, some extra rules apply:

  • If you edit a Jinja template, changes apply instantly (only page refresh required)
  • If you edit Python code of the extensions, you need to restart the WSGI server (vagrant ssh and sudo supervisorctl restart all).
  • If you edit Javascript, you need to run the frontend build to compile and minify files (vagrant ssh, cd /vagrant/ansible and ansible-playbook -v -i inventories/vagrant frontend-build.yml).

Translations

Navigate into the root folder of module which translation keys need to be updated and run following commands:

# Need to be ran only if it's first time to extract translations
. /usr/lib/ckan/default/bin/activate
python setup.py extract_messages

Repository structure

.
├── ansible
│   ├── deploy-all.yml                  Top-level playbook for configuring complete service
│   ├── inventories                     Target server lists (hostname, ssh user and key)
│   ├── roles                           Main configuration
│   └── vars                            Variables common for all roles
│       ├── api-catalog-secrets         Passwords and other secrets (not included here)
│       ├── common.yml                  Variables common for all roles and environments
│       ├── environment-specific        Configuration specific for each deployment env
│       └── secrets-defaults.yml        Default passwords, used in Vagrant
├── ckanext                             Custom CKAN extensions, main source directory
├── doc                                 Documentation
└── Vagrantfile                         Configuration for local development environment

Support / Contact / Contribution

Please file a new issue at GitHub.

Copying and License

This material is copyright (c) 2015-2020 Digital and Population Data Services Agency, Finland.

CKAN-related content like CKAN extensions are licensed under the GNU Affero General Public License (AGPL) v3.0 whose full text may be found at: http://www.fsf.org/licensing/licenses/agpl-3.0.html

All other content in this repository is licensed under the MIT license.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].