A flask blueprint providing an API for accessing and searching an ElasticSearch index created from source datapackages

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for akariv from gravatar.com akariv

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Adam Kariv
  • Tags data
Classifiers

Project description

apies

Travis Coveralls PyPI - Python Version

apies is a flask blueprint providing an API for accessing and searching an ElasticSearch index created from source datapackages.

endpoints

TBD

configuration

Flask configuration for this blueprint:

    from apies import apies_blueprint
    import elasticsearch

    app.register_blueprint(
        apies_blueprint(['path/to/datapackage.json', Package(), ...],
                        elasticsearch.Elasticsearch(...), 
                        'index-to-search-in', 
                        document_doctype='document',
                        dont_highlight=['fields', 'not.to', 'highlight']),
        url_prefix='/search/'
    )

local development

You can start a local development server by following these steps:

  1. Install Dependencies:

    a. Install Docker locally

    b. Install Python dependencies:

    $ pip install dataflows datapackage-pipelines-elasticsearch
$ pip install -e .

  2. Go to the sample/ directory

  3. Start ElasticSearch locally:

    $ ./start_elasticsearch.sh

    This script will wait and poll the server until it's up and running. You can test it yourself by running:

    $ curl -s http://localhost:9200
 {
     "name" : "DTsRT6T",
     "cluster_name" : "elasticsearch",
     "cluster_uuid" : "QnLVHaOYTkmJZzkCG3Hong",
     "version" : {
         "number" : "5.5.2",
         "build_hash" : "b2f0c09",
         "build_date" : "2017-08-14T12:33:14.154Z",
         "build_snapshot" : false,
         "lucene_version" : "6.6.0"
     },
     "tagline" : "You Know, for Search"
 }

  4. Load data into the database

    $ python load_fixtures.py

    You can test that data was loaded:

    $ curl -s http://localhost:9200/jobs/_count?pretty
 {
     "count" : 3516,
     "_shards" : {
             "total" : 5,
             "successful" : 5,
             "failed" : 0
     }
 }

  5. Start the sample server

    $ python server.py 
 * Serving Flask app "server" (lazy loading)
 * Environment: production
 WARNING: Do not use the development server in a production environment.
 Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

  6. Now you can hit the server's endpoints, for example:

         $ curl -s 'localhost:5000/api/search/jobs?q=engineering&size=2' | jq
     127.0.0.1 - - [26/Jun/2019 10:45:31] "GET /api/search/jobs?q=engineering&size=2 HTTP/1.1" 200 -
     {
         "search_counts": {
             "_current": {
             "total_overall": 617
             }
         },
         "search_results": [
             {
             "score": 18.812,
             "source": {
                 "# Of Positions": "5",
                 "Additional Information": "TO BE APPOINTED TO ANY CIVIL <em>ENGINEERING</em> POSITION IN BRIDGES, CANDIDATES MUST POSSESS ONE YEAR OF CIVIL <em>ENGINEERING</em> EXPERIENCE IN BRIDGE DESIGN, BRIDGE CONSTRUCTION, BRIDGE MAINTENANCE OR BRIDGE INSPECTION.",
                 "Agency": "DEPARTMENT OF TRANSPORTATION",
                 "Business Title": "Civil Engineer 2",
                 "Civil Service Title": "CIVIL ENGINEER",
                 "Division/Work Unit": "<em>Engineering</em> Review & Support",
         ...
     }

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for akariv from gravatar.com akariv

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Adam Kariv
  • Tags data
Classifiers

Release history Release notifications | RSS feed

1.11.0

1.10.1

1.10.0

1.9.1

1.9.0

1.8.2

1.8.1

1.8.0

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.8

1.6.7

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.9

1.5.8

1.5.7

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.1

1.4.0

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.2

1.2.1

1.2.0

1.1.10

1.1.9

1.1.8

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.1

1.0.0

0.1.1

0.1.0

0.0.23

0.0.22

0.0.21

0.0.20

This version

0.0.19

0.0.18

0.0.17

0.0.16

0.0.13

0.0.12

0.0.11

0.0.10

0.0.9

0.0.8

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apies-0.0.19.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

apies-0.0.19-py2.py3-none-any.whl (9.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file apies-0.0.19.tar.gz.

File metadata

  • Download URL: apies-0.0.19.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.1

File hashes

Hashes for apies-0.0.19.tar.gz
Algorithm Hash digest
SHA256 dd7e9b3426f668999e34326ca3076b34248a13c0801a78df4599bc82b0224fa3
MD5 4f391848405ce42a39ddbaf7e9dfa874
BLAKE2b-256 ed82b7663ef38cfb0fb95735dc905cd9cd5546a0b6659c8a5acef795cbae735d

See more details on using hashes here.

Provenance

File details

Details for the file apies-0.0.19-py2.py3-none-any.whl.

File metadata

  • Download URL: apies-0.0.19-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.1

File hashes

Hashes for apies-0.0.19-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6231a51f7377945f30f354576dea7d3073be04ac3db1e11724890c8da7b222df
MD5 d611ec256bad6dd16e07928e1ffeba0e
BLAKE2b-256 a131d5f0937a84b201584c318ec0a730e3d5df845beb4ecf83844fc360c779ad

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page