semvec/pypi-packages huggingface dataset:
mdgt 0.1.0
Microdata-Parsing Microservice
License: MIT
Keywords: microdata

mdgt
====
**mdgt** is a microservice which parses microdata.  **mdgt** is still
in the initial design and development phase.

Quick Instructions
------------------
**Command Line Output:** `python -m mdgt [options] [provider] [query]`

* `[provider]` The name of the provider, must be in `/providers/`
* `[query]` The query the provider will use to obtain output

Options:
* `--console`, `-c`: Output to stdout in a readable format (default)
* `--config`, `-f`: Path to configuration file to use
* `--json`, `-j`: Output to stdout as json
* `--providers`, `-p`: Output to stdout a list of available providers
* `--provider-dir`, `-pd`: Define a different providers directory

**RESTful Web Server**: `python -m mdgt -w [port(optional)]`

This starts a WSGI-compliant web server at the specified port (default `8181`).  The
api is invoked with `http://domain:port/provider/query`, or `http://domain:port/providers`
(for a list of available providers).

Configuration file structure
----------------------------

It is possible to use an optional configuration file by using the
`--config`/`- f` flag or placing a file called `mdgt.conf` in the current working
directory. It can have the following values:

```conf
console = true|false
json = true|false
provider-dir = path/to/dir
```

Note that command-line arguments will override those present in the configuration
file.

Development instructions
------------------------
**Windows:** Use the handy win_init.ps1 script to set up the virtual
environment and install dependencies to it. PyPI doesn't have 64-bit binaries
for lxml, so the whl file is included and installed from the script.

**Linux/Mac users:** Set up a virtual environment with `python -m venv venv`, activate it,
then install the dependencies with `pip install requirements.txt`.