kerkoapp | web application that provides a faceted search interface
kandi X-RAY | kerkoapp Summary
kandi X-RAY | kerkoapp Summary
kerkoapp is a Python library. kerkoapp has no bugs, it has no vulnerabilities, it has a Permissive License and it has low support. However kerkoapp build file is not available. You can download it from GitHub.
KerkoApp is a web application that uses Kerko to provide a user-friendly search and browsing interface for sharing a bibliography managed with the Zotero reference manager. It is built in Python with the Flask framework. Although this application may be deployed as is on a web server, it is primarily meant to serve as an example on how to integrate Kerko into a Flask application. Basic configuration options can be set with environment variables, but for more advanced customizations one should consider building a custom application (possibly using KerkoApp as a starting point), and configuring Kerko through its Python interface.
KerkoApp is a web application that uses Kerko to provide a user-friendly search and browsing interface for sharing a bibliography managed with the Zotero reference manager. It is built in Python with the Flask framework. Although this application may be deployed as is on a web server, it is primarily meant to serve as an example on how to integrate Kerko into a Flask application. Basic configuration options can be set with environment variables, but for more advanced customizations one should consider building a custom application (possibly using KerkoApp as a starting point), and configuring Kerko through its Python interface.
Support
Quality
Security
License
Reuse
Support
kerkoapp has a low active ecosystem.
It has 44 star(s) with 17 fork(s). There are 4 watchers for this library.
It had no major release in the last 6 months.
There are 1 open issues and 18 have been closed. On average issues are closed in 34 days. There are 2 open pull requests and 0 closed requests.
It has a neutral sentiment in the developer community.
The latest version of kerkoapp is 0.9
Quality
kerkoapp has 0 bugs and 0 code smells.
Security
kerkoapp has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.
kerkoapp code analysis shows 0 unresolved vulnerabilities.
There are 0 security hotspots that need review.
License
kerkoapp is licensed under the BSD-3-Clause License. This license is Permissive.
Permissive licenses have the least restrictions, and you can use them in most projects.
Reuse
kerkoapp releases are not available. You will need to build from source code and install.
kerkoapp has no build file. You will be need to create the build yourself to build the component from source.
Installation instructions, examples and code snippets are available.
It has 236 lines of code, 13 functions and 5 files.
It has medium code complexity. Code complexity directly impacts maintainability of the code.
Top functions reviewed by kandi - BETA
kandi has reviewed kerkoapp and discovered the below as its top functions. This is intended to give you an instant insight into kerkoapp implemented functionality, and help decide if they suit your requirements.
- Create a Flask app instance
- Register error handlers
- Register the kerko blueprint
- Register extension extensions
Get all kandi verified functions for this library.
kerkoapp Key Features
No Key Features are available at this moment for kerkoapp.
kerkoapp Examples and Code Snippets
No Code Snippets are available at this moment for kerkoapp.
Community Discussions
No Community Discussions are available at this moment for kerkoapp.Refer to stack overflow page for discussions.
Community Discussions, Code Snippets contain sources that include Stack Exchange Network
Vulnerabilities
No vulnerabilities reported
Install kerkoapp
This section presents two approaches to getting started with KerkoApp: running from a standard installation of KerkoApp, or running from a Docker container pre-built with KerkoApp. You may choose the one you are most comfortable with.
This procedure requires Python 3.7 or later. Note that Flask's built-in server is not suitable for production as it doesn’t scale well. You'll want to consider better options, such as the WSGI servers suggested in Flask's documentation.
The first step is to install the software. As with any Python package, it is highly recommended to install it within a virtual environment. git clone https://github.com/whiskyechobravo/kerkoapp.git cd kerkoapp pip install -r requirements/run.txt This will install many packages required by Kerko or KerkoApp.
Copy dotenv.sample to .env. Open .env in a text editor to assign proper values to the variables outlined below. KERKO_TITLE: The title to display in web pages. SECRET_KEY: This variable is required for generating secure tokens in web forms. It should have a secure, random value and it really has to be secret. For this reason, never add your .env file to a code repository. KERKO_ZOTERO_API_KEY, KERKO_ZOTERO_LIBRARY_ID and KERKO_ZOTERO_LIBRARY_TYPE: These variables are required for Kerko to be able to access your Zotero library. See Environment variables for details.
Have KerkoApp retrieve your data from zotero.org: flask kerko sync If you have a large bibliography and/or large file attachments, that command may take a while to complete (and there is no progress indicator). In production use, that command is usually added to the crontab file for regular execution. Alternatively, to get a better sense of the synchronization process, you could use the following command, which will cause Kerko to output various informational messages: LOGGING_LEVEL=INFO flask kerko sync
Run KerkoApp: flask run
Open http://localhost:5000/ in your browser and explore the bibliography.
This procedure requires Python 3.7 or later. Note that Flask's built-in server is not suitable for production as it doesn’t scale well. You'll want to consider better options, such as the WSGI servers suggested in Flask's documentation.
The first step is to install the software. As with any Python package, it is highly recommended to install it within a virtual environment. git clone https://github.com/whiskyechobravo/kerkoapp.git cd kerkoapp pip install -r requirements/run.txt This will install many packages required by Kerko or KerkoApp.
Copy dotenv.sample to .env. Open .env in a text editor to assign proper values to the variables outlined below. KERKO_TITLE: The title to display in web pages. SECRET_KEY: This variable is required for generating secure tokens in web forms. It should have a secure, random value and it really has to be secret. For this reason, never add your .env file to a code repository. KERKO_ZOTERO_API_KEY, KERKO_ZOTERO_LIBRARY_ID and KERKO_ZOTERO_LIBRARY_TYPE: These variables are required for Kerko to be able to access your Zotero library. See Environment variables for details.
Have KerkoApp retrieve your data from zotero.org: flask kerko sync If you have a large bibliography and/or large file attachments, that command may take a while to complete (and there is no progress indicator). In production use, that command is usually added to the crontab file for regular execution. Alternatively, to get a better sense of the synchronization process, you could use the following command, which will cause Kerko to output various informational messages: LOGGING_LEVEL=INFO flask kerko sync
Run KerkoApp: flask run
Open http://localhost:5000/ in your browser and explore the bibliography.
Support
For reporting an issue, please consider the following guidelines:.
Find more information at:
Reuse Trending Solutions
Find, review, and download reusable Libraries, Code Snippets, Cloud APIs from over 650 million Knowledge Items
Find more librariesStay Updated
Subscribe to our newsletter for trending solutions and developer bootcamps
Share this Page
