Flamyngo is a customizable Flask frontend for MongoDB.
Project description
# Flamyngo
Flamyngo is a customizable Flask frontend for MongoDB.
At the most basic level, the aim is to delegate most settings to a YAML
configuration file, which then allows the underlying code to be reused for
any conceivable collection. Querying and display is restricted to a single
collection for now. However, the code can serve as a starting point for more
complex setups to support multiple collections.
# Usage
Clone or download the code. Install it if you wish.
In the root directory, run:
```bash
python scripts/flm --config <path/to/config.yaml>
```
If `--config` is not provided, it defaults to `$HOME/.flamyngo.yaml`.
# Configuration
A sample commented configuration yaml file is given below.
```yaml
# MongoDB settings
db:
host: mongo.host.com
port: 27017
username: user
password: password
database: mydb
collections:
-
name: mycoll
# These set the special queries as an ordered list of [<key>, <regex string>, <type>].
# If the query string satisfies any of the regex, the Mongo query is set as
# {<key>: type(<search_string>)}. This allows for much more friendly setups for common
# queries that do not require a user to type in verbose Mongo criteria. Each
# regex should be uniquely identifying.
# Supported types include int, float, str, objectid.
# If none of the regex works, the criteria is interpreted as a Mongo-like dict query.
query:
- [last_name, '^[A-Za-z]+$', str]
- [phone_number, '^[0-9]+$', int]
# A default list of projections to display as a table. Only keys in the root of
# the document is supported right now.
summary:
- [_id, str]
- [first_name, str]
- [last_name, str]
- [phone_number, str]
# The following defines unique identifiers for each doc. This allows each
# specific doc to be queried and displayed using this key. If this key is
# present in the default list of projections, a link will be created to each
# unique document.
unique_key: _id
unique_key_type: bson.objectid.ObjectId
```
Flamyngo is a customizable Flask frontend for MongoDB.
At the most basic level, the aim is to delegate most settings to a YAML
configuration file, which then allows the underlying code to be reused for
any conceivable collection. Querying and display is restricted to a single
collection for now. However, the code can serve as a starting point for more
complex setups to support multiple collections.
# Usage
Clone or download the code. Install it if you wish.
In the root directory, run:
```bash
python scripts/flm --config <path/to/config.yaml>
```
If `--config` is not provided, it defaults to `$HOME/.flamyngo.yaml`.
# Configuration
A sample commented configuration yaml file is given below.
```yaml
# MongoDB settings
db:
host: mongo.host.com
port: 27017
username: user
password: password
database: mydb
collections:
-
name: mycoll
# These set the special queries as an ordered list of [<key>, <regex string>, <type>].
# If the query string satisfies any of the regex, the Mongo query is set as
# {<key>: type(<search_string>)}. This allows for much more friendly setups for common
# queries that do not require a user to type in verbose Mongo criteria. Each
# regex should be uniquely identifying.
# Supported types include int, float, str, objectid.
# If none of the regex works, the criteria is interpreted as a Mongo-like dict query.
query:
- [last_name, '^[A-Za-z]+$', str]
- [phone_number, '^[0-9]+$', int]
# A default list of projections to display as a table. Only keys in the root of
# the document is supported right now.
summary:
- [_id, str]
- [first_name, str]
- [last_name, str]
- [phone_number, str]
# The following defines unique identifiers for each doc. This allows each
# specific doc to be queried and displayed using this key. If this key is
# present in the default list of projections, a link will be created to each
# unique document.
unique_key: _id
unique_key_type: bson.objectid.ObjectId
```
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
flamyngo-0.1.2.tar.gz
(12.9 kB
view details)
Built Distribution
flamyngo-0.1.2-py27-none-any.whl
(15.0 kB
view details)
File details
Details for the file flamyngo-0.1.2.tar.gz.
File metadata
- Download URL: flamyngo-0.1.2.tar.gz
- Upload date:
- Size: 12.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 01a3625347ed7715e8dcdfc01e32281403b5926aa633a3fbd73a637adea2c563 |
|
| MD5 | 9d9d6b047af8d05e3ecb40a789e53841 |
|
| BLAKE2b-256 | b6c34fa7e92ce4d64e9e674917e697260bf6163427adf793a8b201506489bb44 |
File details
Details for the file flamyngo-0.1.2-py27-none-any.whl.
File metadata
- Download URL: flamyngo-0.1.2-py27-none-any.whl
- Upload date:
- Size: 15.0 kB
- Tags: Python 2.7
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cd479ccac836668398ec0bde0eb95234e6d1f44212e8282a88773aa2fd48f211 |
|
| MD5 | e8f837da091d98eb05038cd5e3db5e5c |
|
| BLAKE2b-256 | f6b8cc500a3cc45c4a5091196e89d0cd95259e3cb26aac503c42103942989c16 |
