Skip to main content

A client for working with the [Percolate database](https://github.com/Percolation-Labs/percolate)

Project description

Percolate API

The API supports the database by providing a REST interface for maintenance tasks or to test the concepts of adding APIs to AI systems. The docker compose master file will include the API so by using docker compose up in the root, you should have an API running on port 5008.

But you can also launch it from here as describe below.

From this folder location (we use port 5000 for dev and 5008 for docker to avoid conflict on ports)

uvicorn percolate.api.main:app --port 5000 --reload
#browse to http://127.0.0.1:5000/docs for swagger

Or from docker - you can use a local docker build. For example

# build with some tag
docker build -t p8-api .
# run it in the background -> this will spit out a container id or you can use a name like p8c
docker run -d -p 5008:5008 --name p8c p8-api
# browse to localhost:5008/docs and you should see the swagger
# troubleshoot launch using the container ID output from the earlier step
docker log p8c

To clean up

#docker stop p8c OR
docker rm -f p8c
#docker system prune -f

Tests

WIP - run tests in the python directory with pytest . - at the moment there is a test application of the schema on a test database that assumes the docker instance is running.

Note on Jupyter

There are a number of notebooks used for illustration and/or testing

git attribute removes contents on commit to avoid checking in output cells.

git config --global filter.strip-notebook-output.clean "jq --indent 1 '.cells[] |= if .outputs then .outputs = [] else . end | .metadata = {}' 2>/dev/null || cat"

Issues encountered

Project details


Release history Release notifications | RSS feed

This version

0.3.5

Download files

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

Source Distribution

percolate_db-0.3.5.tar.gz (408.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

percolate_db-0.3.5-py3-none-any.whl (486.5 kB view details)

Uploaded Python 3

File details

Details for the file percolate_db-0.3.5.tar.gz.

File metadata

  • Download URL: percolate_db-0.3.5.tar.gz
  • Upload date:
  • Size: 408.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.13 Linux/6.11.0-1018-azure

File hashes

Hashes for percolate_db-0.3.5.tar.gz
Algorithm Hash digest
SHA256 450316048619b5a55168555c0394c9c69cae520ce04495212843893894c22044
MD5 b5fa4b2bcf1cb17ca30bb0e1862396d8
BLAKE2b-256 ee531ff698d1a491d4788e60a14e8d2be41e0c401fb01e16f1c2bf2f0dc35656

See more details on using hashes here.

File details

Details for the file percolate_db-0.3.5-py3-none-any.whl.

File metadata

  • Download URL: percolate_db-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 486.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.13 Linux/6.11.0-1018-azure

File hashes

Hashes for percolate_db-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6b3976d49252169ff57b4afca673957fba91329f10a7594ddf16e86162247028
MD5 1116eb078b4d4e730b6109fc317aa9c4
BLAKE2b-256 84b1e14ecc9a3e8f863d439f35fe6a047f48da8d590851b3a1cd28ea77fa09d1

See more details on using hashes here.

Supported by

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